66[ ![ Dependencies] ( https://img.shields.io/librariesio/github/craigthomas/Chip8Java?style=flat-square )] ( https://libraries.io/github/craigthomas/Chip8Java )
77[ ![ License: MIT] ( https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square )] ( https://opensource.org/licenses/MIT )
88
9+ ## Table of Contents
10+
11+ 1 . [ What is it?] ( #what-is-it )
12+ 2 . [ License] ( #license )
13+ 3 . [ Compiling] ( #compiling )
14+ 4 . [ Running] ( #running )
15+ 1 . [ Requirements] ( #requirements )
16+ 2 . [ Starting the Emulator] ( #starting-the-emulator )
17+ 3 . [ Running a ROM] ( #running-a-rom )
18+ 4 . [ Screen Scale] ( #screen-scale )
19+ 5 . [ Execution Delay] ( #execution-delay )
20+ 6 . [ Debug Mode] ( #debug-mode )
21+ 5 . [ Keys] ( #keys )
22+ 1 . [ Regular Keys] ( #regular-keys )
23+ 2 . [ Debug Keys] ( #debug-keys )
24+ 6 . [ Modes] ( #modes )
25+ 1 . [ Trace Mode] ( #trace-mode )
26+ 2 . [ Step Mode] ( #step-mode )
27+ 7 . [ Third Party Licenses and Attributions] ( #third-party-licenses-and-attributions )
28+ 1 . [ JCommander] ( #jcommander )
29+ 2 . [ Apache Commons IO] ( #apache-commons-io )
30+ 3 . [ Vera Mono Font] ( #vera-mono-font )
31+
932## What is it?
1033
1134This project is a Chip 8 emulator written in Java. There are two other versions
@@ -47,17 +70,30 @@ On Windows, switch to the root of the source directory, and type:
4770
4871 gradlew.bat build
4972
50- The compiled Jar file will be placed in the ` build/libs ` directory.
73+ The compiled Jar file will be placed in the ` build/libs ` directory, as a file called
74+ ` emulator-1.0-all.jar ` .
5175
5276
5377## Running
5478
79+ ### Requirements
80+
81+ To run the emulator, you will need to install the Java Runtime Environment (JRE)
82+ on your computer. The Oracle JRE can be downloaded from [ www.java.com ] ( http://www.java.com ) .
83+
84+ ### Starting the Emulator
85+
86+ By default, the emulator can start up without a ROM loaded. Simply double click
87+ the JAR file, or run it with the following command line:
88+
89+ java -jar emulator-1.0-all.jar
90+
5591### Running a ROM
5692
5793The command-line interface currently requires a single argument, which
5894is the full path to a Chip 8 ROM:
5995
60- java -jar build/libs/ emulator-1.0-all.jar /path/to/rom/filename
96+ java -jar emulator-1.0-all.jar /path/to/rom/filename
6197
6298This will start the emulator with the specified ROM.
6399
@@ -66,7 +102,7 @@ This will start the emulator with the specified ROM.
66102The ` -s ` switch will scale the size of the window (the original size
67103at 1x scale is 64 x 32):
68104
69- java -jar build/libs/ emulator-1.0-all.jar /path/to/rom/filename -s 10
105+ java -jar emulator-1.0-all.jar /path/to/rom/filename -s 10
70106
71107The command above will scale the window so that it is 10 times the normal
72108size.
76112You may also wish to experiment with the ` -d ` switch, which instructs
77113the emulator to add a delay to every operation that is executed. For example,
78114
79- java -jar build/libs/ emulator-1.0-all.jar /path/to/rom/filename -d 10
115+ java -jar emulator-1.0-all.jar /path/to/rom/filename -d 10
80116
81117The command above will add a 10 ms delay to every opcode that is executed.
82118This is useful for very fast computers (note that it is difficult to find
@@ -90,7 +126,7 @@ You can also ask the emulator to start in debug mode, where each
90126instruction is disassembled and displayed in the bottom left hand corner
91127of the screen on a semi-transparent overlay. To do this:
92128
93- java -jar build/libs/ emulator-1.0-all.jar /path/to/rom/filename -t
129+ java -jar emulator-1.0-all.jar /path/to/rom/filename -t
94130
95131## Keys
96132
@@ -161,12 +197,12 @@ Step mode can also be accessed by clicking on `CPU`->`Step Mode`.
161197
162198## Third Party Licenses and Attributions
163199
164- ### Apache Commons CLI
200+ ### JCommander
165201
166- This links to the Apache Commons CLI , which is licensed under the
202+ This links to the JCommander library , which is licensed under the
167203Apache License, Version 2.0. The license can be downloaded from
168204http://www.apache.org/licenses/LICENSE-2.0.html . The source code for this
169- software is available from http ://commons.apache.org/cli
205+ software is available from [ https ://github.com/cbeust/jcommander ] ( https://github.com/cbeust/jcommander )
170206
171207### Apache Commons IO
172208
0 commit comments