https://github.com/kosarev/zx
ZX Spectrum emulator written in a mix of Python and C++
https://github.com/kosarev/zx
converter emulator mit-license python rzx rzx-playback sinclair sinclair-zx-spectrum spectrum spectrum-emulator tape wav z80 zx-spectrum zx-spectrum-emulator zxspectrum
Last synced: 4 months ago
JSON representation
ZX Spectrum emulator written in a mix of Python and C++
- Host: GitHub
- URL: https://github.com/kosarev/zx
- Owner: kosarev
- License: mit
- Created: 2017-10-07T08:27:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-07T12:50:20.000Z (almost 4 years ago)
- Last Synced: 2024-10-24T18:35:24.962Z (about 1 year ago)
- Topics: converter, emulator, mit-license, python, rzx, rzx-playback, sinclair, sinclair-zx-spectrum, spectrum, spectrum-emulator, tape, wav, z80, zx-spectrum, zx-spectrum-emulator, zxspectrum
- Language: Python
- Homepage: https://twitter.com/z80tools
- Size: 3.52 MB
- Stars: 21
- Watchers: 3
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zx
ZX Spectrum emulation framework in Python and C++
[More screenshots](https://github.com/kosarev/zx/tree/master/screenshots)
### Features
* Designed to be suitable for research and development purposes
such as unattended testing of Spectrum software, timing
analysis, etc.
* Meant to be easy to customize and re-use via Python interfaces.
* Fast and accurate emulation.
* Based on the fast and flexible
[Z80 emulator](https://github.com/kosarev/z80).
### Development status
* Platforms: Linux and Windows (via SDL2).
* General status: working pre-alpha.
* Supported machines: 48K only for now.
* Display: multi-colour effects,
[accurate timings](https://github.com/kosarev/zx/blob/master/test/screen_timing).
* Sound: EAR beeper and tape output supported.
* Tape: TAP and TZX formats supported as well as conversion to WAV.
* Snapshots: Z80.
* Playback recordings: RZX.
* Joystick: Xbox controllers supported via `evdev` (Linux only), mapped to cursor keys.
### Installation and running
For the latest release:
```shell
$ pip install --upgrade pip
$ pip install --upgrade setuptools wheel
$ pip install zx
```
Or directly from the repository for current development version:
```shell
$ pip install --upgrade setuptools wheel
$ pip install git+https://github.com/kosarev/zx
```
Local development setups are also supported:
```shell
$ git clone --recursive https://github.com/kosarev/zx
$ cd zx
$ pip install --upgrade setuptools wheel
$ pip install --editable .
```
Running:
```shell
$ zx
```
### Controls
`F1` displays help.
`F2` is to save snapshot.
`F3` is to load snapshot or tape file.
`F6` pauses/resumes tape.
`F10` quits the emulator.
`F11` and double click switch between fullscreen and windowed mode.
`PAUSE` and mouse click pause/resume emulation or RZX playback.
Any Spectrum key stroke resumes emulation and leaves the RZX
playback mode back to the regular emulation mode.
### Running snapshots, recordings and tapes
```shell
$ zx elven.z80
```
```shell
$ zx exolon.rzx
```
```shell
$ zx https://www.worldofspectrum.org/pub/sinclair/games/e/EricTheFloaters.tzx.zip
```
### Supported formats
Snapshots: `.z80`.
Tapes: `.tap`, `.tzx`, `.wav`.
Playbacks: `.rzx`.
Screenshots: `.scr`.
[ZX Basic compiler](https://github.com/boriel/zxbasic) sources: `.zxb`.
Archives: `.zip`.
### Converting files
```shell
$ zx jack.tzx jack.wav
```
```shell
$ zx eric.tap eric.z80
```
### Dumping files
```shell
$ zx dump rick.z80
OrderedDict([('id', 'z80_snapshot'), ('a', 213), ('f', 66), ...
```
On the `dump` command, **zx** parses the specified file (that can
be of any supported format) in the form of raw Python data.
### Reference papers
* [Screen timings](https://github.com/kosarev/zx/blob/master/test/screen_timing/SCREEN_TIMING.md)