https://github.com/pushfoo/eightdad
A Chip-8 interpreter in python that may include other tools in the future
https://github.com/pushfoo/eightdad
chip8 chip8-emulator chip8-interpreter
Last synced: about 1 month ago
JSON representation
A Chip-8 interpreter in python that may include other tools in the future
- Host: GitHub
- URL: https://github.com/pushfoo/eightdad
- Owner: pushfoo
- License: bsd-2-clause
- Created: 2020-04-11T14:47:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T05:05:05.000Z (over 1 year ago)
- Last Synced: 2025-03-12T23:35:17.525Z (about 2 months ago)
- Topics: chip8, chip8-emulator, chip8-interpreter
- Language: Python
- Size: 212 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EightDAD
[](https://github.com/pushfoo/eightdad/actions/workflows/tests.yaml)
[](https://opensource.org/licenses/BSD-2-Clause)
## Overview
### What
For now, it's only a [Chip-8 Virtual Machine](https://en.wikipedia.org/wiki/CHIP-8) in python.
The name comes from the tools I hope to add:
- [x] **Eight**, as in Chip-8 VM
- [ ] **D**ebugger
- [ ] **A**ssembler
- [ ] **D**isassembler
Only the [classic CHIP-8 instruction set](https://github.com/mattmikolay/chip-8/wiki/CHIP%E2%80%908-Technical-Reference)
is currently supported. [XO-CHIP](http://johnearnest.github.io/Octo/docs/XO-ChipSpecification.html) and other extensions
are not currently supported, but may be added one day.
### How
#### Requirements
1. Python Version >= 3.8
2. (GUI only) OpenGL 3.3+, Python version < 3.12
3. (TUI only) Unicode support in your terminal
The GUI does not yet work with Python 3.11 due to arcade's dependencies not yet supporting it.
#### Installing
1. Clone this repo locally
2. [Make a new virtualenv and activate it](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
3. Change directories into the repo copy
4. `pip install .` if you only want to run ROMs, or `pip install -e .` to install an editable copy.
Dependencies will be automatically installed.
#### Running roms
*Reminder: only the original CHIP-8 instruction set is supported.*
To run a ROM, make sure you're in the activated virtual environment, then use the following:
```commandline
eightdad -r path/to/chip8.rom
```
If you want to use the TUI, run `eightdad-tui` instead.
```commandline
eightdad-tui -r path/to/chip8.rom
```
For additional information, use the help option:
```
eightdad --help
```
### Why
I want to learn more about assemblers, Virtual Machines, and implementing
languages! This is a step toward other projects and becoming a better
developer.
#### But [Octo](https://github.com/JohnEarnest/Octo) already exists!
I know. I like it, and I've contributed to both Octo and its more resource-effiicent C implementation, [c-octo](https://github.com/JohnEarnest/c-octo). Writing my own tools will help me more with the goals above.