@@ -66,41 +66,43 @@ and run the emulator in, without touching your master Python environment.
66
66
67
67
### Ubuntu Installation
68
68
69
- The installation under Ubuntu requires several different steps:
69
+ The installation under Ubuntu 20.04 requires several different steps:
70
70
71
71
1 . Install SDL libraries. The SDL (Simple DirectMedia Layer) libraries are used by PyGame to draw
72
72
images on the screen. Several other dependencies are needed by SDL in order to install PyGame.
73
73
To install the required SDL libraries (plus dependencies) from the command-line:
74
74
75
75
```
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
79
79
```
80
80
81
81
2 . Install PIP. The ` pip ` package manager is used for managing Python packages. To install ` pip `
82
82
from the command-line:
83
83
84
84
```
85
- sudo apt-get install python -pip
85
+ sudo apt install python3 -pip
86
86
```
87
87
88
88
3 . (* Optional* ) Install virtual environment support for Python:
89
89
90
90
1 . Install virtual environment support:
91
91
92
92
```
93
- pip install virtualenv
94
- pip install virtualenvwrapper
93
+ pip3 install virtualenv
94
+ pip3 install virtualenvwrapper
95
95
```
96
96
97
97
2. First you must update your `.bashrc` file in the your home directory and add a few lines
98
98
to the bottom of that file:
99
99
100
100
```
101
101
cat >> ~/.bashrc << EOF
102
+ export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3
102
103
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
104
106
EOF
105
107
```
106
108
@@ -119,7 +121,7 @@ from the command-line:
119
121
5. Clone (or download) the Chip 8 emulator project:
120
122
121
123
```
122
- sudo apt-get install git
124
+ sudo apt install git
123
125
git clone https://github.com/craigthomas/Chip8Python.git
124
126
```
125
127
@@ -134,7 +136,7 @@ from the command-line:
134
136
135
137
1. Download and install [Python 3.6.8 for Windows](https://www.python.org/downloads/release/python-368/).
136
138
Make 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.
138
140
139
141
2. (*Optional*) Install virtual environment support for Python. Run the following commands from a command prompt:
140
142
@@ -171,17 +173,18 @@ in the directory where you cloned or downloaded the source files:
171
173
172
174
### Running a ROM
173
175
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
+
174
181
The command-line interface requires a single argument, which is the full
175
182
path to a Chip 8 ROM. Run the following command in the directory where you
176
183
cloned or downloaded the source files:
177
184
178
185
python yac8e.py /path/to/rom/filename
179
186
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.
185
188
186
189
### Screen Scale
187
190
@@ -254,13 +257,17 @@ keys that impact the execution of the emulator.
254
257
255
258
## ROM Compatibility
256
259
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:
258
262
259
263
| ROM Name | Works Correctly | Notes |
260
264
| :-------- | :----------------: | :---------------------------------------------------------------------------------- |
261
265
| 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 |
264
271
265
272
266
273
## Further Documentation
0 commit comments