|Corey Prophitt d87df64362 Fixed URL reference||4 years ago|
|chip8||4 years ago|
|docs||4 years ago|
|screenshots||4 years ago|
|tests||4 years ago|
|.gitignore||4 years ago|
|.travis.yml||4 years ago|
|Makefile||4 years ago|
|README.md||4 years ago|
|c8d||4 years ago|
|pylintrc||4 years ago|
|setup.cfg||4 years ago|
|setup.py||4 years ago|
A Chip-8 disassembler in Python
The disassembly is based on Cowgod's Chip-8 technical reference document. The
document can be found here.
If the document is unavailable you can find a saved copy within the
The easiest way to install c8d is via PyPi, this can be done with the following command:
$ pip install c8d
Note, sudo may or may not be required depending on your environment.
The second way to install is by cloning the repository and installing the development version of the pip package:
$ git clone https://github.com/prophittcorey/c8d.git $ cd c8d $ make install
The pip package installs the c8d executable as well as the chip8 package which can be used to write your own scripts.
Note, you may have to source your shell for the c8d executable to be picked up.
The c8d executable currently supports two command line arguments:
-h, prints the program usage
-f FILE, input file to be processed and disassembled
$ c8d -f WIPEOFF
Note, if you wish to store the disassembly to a file you can redirect the output to a file:
$ c8d -f WIPEOFF > wipeoff.c8
A make task has been included that installs all linters and testing packages
that are required for development. The command is
make init. Once run,
development can ensue.
Once all dependencies have been installed the linters and tests can be run. The following commands are useful:
make lintruns all linters on all Python code
make testruns all unit tests
A Chip-8 disassembler in Python Copyright (C) 2015, Corey Prophitt. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.