Skip to content

Commit

Permalink
caveats about parallelism
Browse files Browse the repository at this point in the history
  • Loading branch information
Kautenja committed Jun 16, 2020
1 parent fe25ac6 commit 0a49e85
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@ nes_py -h
| E | Backup State |
| R | Restore State |

## Parallelism Caveats

both the `threading` and `multiprocessing` packages are supported by
`nes-py` with some caveats related to rendering:

1. rendering **is not** supported from instances of `threading.Thread`
2. rendering **is** supported from instances of `multiprocessing.Process`,
but `nes-py` must be imported within the process that executes the render
call

# Development

To design a custom environment using `nes-py`, introduce new features, or fix
Expand All @@ -90,10 +100,7 @@ There you will find instructions for:
- reference material for the `NESEnv` API
- documentation for the `nes_py.wrappers` module

# Compatibility

nes-py implements several common mappers, which should be enough for a good
percentage of the games:
# Cartridge Mapper Compatibility

0. NROM
1. MMC1 / SxROM
Expand Down

0 comments on commit 0a49e85

Please sign in to comment.