@@ -66,41 +66,43 @@ and run the emulator in, without touching your master Python environment.
6666
6767### Ubuntu Installation
6868
69- The installation under Ubuntu requires several different steps:
69+ The installation under Ubuntu 20.04 requires several different steps:
7070
71711 . Install SDL libraries. The SDL (Simple DirectMedia Layer) libraries are used by PyGame to draw
7272images on the screen. Several other dependencies are needed by SDL in order to install PyGame.
7373To install the required SDL libraries (plus dependencies) from the command-line:
7474
7575 ```
76- sudo apt-get install libfreetype6 -dev libsdl-dev libsdl-image1.2- dev \
77- libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsdl-sound1.2-dev \
78- libportmidi-dev python-dev
76+ sudo apt install python3 python3 -dev libsdl-dev libfreetype6- dev \
77+ libsdl-image1.2-dev libsdl- mixer1.2-dev libsdl-ttf2.0-dev libsdl-sound1.2-dev \
78+ libportmidi-dev
7979 ```
8080
81812 . Install PIP. The ` pip ` package manager is used for managing Python packages. To install ` pip `
8282from the command-line:
8383
8484 ```
85- sudo apt-get install python -pip
85+ sudo apt install python3 -pip
8686 ```
8787
88883 . (* Optional* ) Install virtual environment support for Python:
8989
9090 1 . Install virtual environment support:
9191
9292 ```
93- pip install virtualenv
94- pip install virtualenvwrapper
93+ pip3 install virtualenv
94+ pip3 install virtualenvwrapper
9595 ```
9696
9797 2. First you must update your `.bashrc` file in the your home directory and add a few lines
9898 to the bottom of that file:
9999
100100 ```
101101 cat >> ~/.bashrc << EOF
102+ export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3
102103 export WORKON_HOME=$HOME/.virtualenvs
103- source /usr/local/bin/virtualenvwrapper.sh
104+ export PATH=$PATH:$HOME/.local/bin
105+ source $HOME/.local/bin/virtualenvwrapper.sh
104106 EOF
105107 ```
106108
@@ -119,7 +121,7 @@ from the command-line:
1191215. Clone (or download) the Chip 8 emulator project:
120122
121123 ```
122- sudo apt-get install git
124+ sudo apt install git
123125 git clone https://github.com/craigthomas/Chip8Python.git
124126 ```
125127
@@ -134,7 +136,7 @@ from the command-line:
134136
1351371. Download and install [Python 3.6.8 for Windows](https://www.python.org/downloads/release/python-368/).
136138Make sure that `pip` and `Add python.exe to Path` options are checked when performing the installation. Later
137- versions of Ptyhon 3 are also likely to work correctly with the emulator.
139+ versions of Python 3 are also likely to work correctly with the emulator.
138140
1391412. (*Optional*) Install virtual environment support for Python. Run the following commands from a command prompt:
140142
@@ -171,17 +173,18 @@ in the directory where you cloned or downloaded the source files:
171173
172174### Running a ROM
173175
176+ Note that if you created a virtual environment as detailed above,
177+ you will need to `workon` that environment before starting the emulator:
178+
179+ workon chip8
180+
174181The command-line interface requires a single argument, which is the full
175182path to a Chip 8 ROM. Run the following command in the directory where you
176183cloned or downloaded the source files:
177184
178185 python yac8e.py /path/to/rom/filename
179186
180- This will start the emulator with the specified ROM. Note that if you created
181- a virtual environment as detailed above, you will need to `workon` that
182- environment before starting the emulator:
183-
184- workon chip8
187+ This will start the emulator with the specified ROM.
185188
186189### Screen Scale
187190
@@ -254,13 +257,17 @@ keys that impact the execution of the emulator.
254257
255258## ROM Compatibility
256259
257- Here are the list of public domain ROMs and their current status with the emulator.
260+ Here are the list of public domain ROMs and their current status with the emulator, along
261+ with keypresses based on the default keymap:
258262
259263| ROM Name | Works Correctly | Notes |
260264| :-------- | :----------------: | :---------------------------------------------------------------------------------- |
261265| MAZE | :heavy_check_mark: | |
262- | MISSILE | :heavy_check_mark: | `u` fires |
263- | PONG | :heavy_check_mark: | `4` left player up, `7` left player down, `v` right player up, `b` right player down|
266+ | MISSILE | :heavy_check_mark: | `U` fires |
267+ | PONG | :heavy_check_mark: | `4` left player up, `7` left player down, `V` right player up, `B` right player down|
268+ | TANK | :heavy_check_mark: | `R` fires, `T` moves right, `7` moves left, `5` moves down, `U` moves up |
269+ | TETRIS | :heavy_check_mark: | `R` moves left, `T` moves right, `Y` moves down, `7` rotates |
270+ | UFO | :heavy_check_mark: | `R` fires up, `T` fires right, `7` fires left |
264271
265272
266273## Further Documentation
0 commit comments