Python Chip 8 emulator

Table of Contents

• Introduction
• Dependancies
• Installation
• Args
• Tests

Introduction

PyChip8 is a CHIP-8 computer interpreter written in Python, which allows you to run programs prepared for this machine directly on your computer. Includes a thesis written in Polish

Dependancies:

• Linux/Unix based OS
• Python 3.7 🐍
• Pipenv (optional)

Installation:

1. Using Pipenv:

• Open termianl install pipenv and go to project directory
• In bash terminal write pipenv install and then pipenv shell
• To run project use python pychip command
• Use deactivate command to kill pipenv shell 💀

2. Using pip:

• Open termianl and go to project directory
• Use pip3 install -r requirements.txt to install all dependencies
• To run project use python3 pyChip8 command

3. Using pip with virtualenv:

• Type in project directory virtualenv venv
• Activate virtual environment by source venv/bin/activate command
• Use pip3 install -r requirements.txt to install all dependencies
• To run project use python3 pyChip8 command
• Use deactivate command to kill virtualenv 💀

5. To run project use python3 pychip

Args

usage: pychip [-h] [-f ROMS] [-d] [-r RES] [-t DLY] [-s SND]

Chip8 emulator

optional arguments:
  -h, --help            show this help message and exit
  -f ROMS, --file ROMS  use to provide roms file
  -d, --disassembler    run disassembler for given roms file
  -r RES, --res RES     set CHIP-8 screen resolution
  -t DLY, --time DLY    set emulation delay time
  -s SND, --sound SND   set sound on/off

Tests

1. Install pytest pip install pytest
2. Run pytest in root directory

App tested on linux, macOS