You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,17 @@
2
2
This emulator supports [CHIP-8](https://en.wikipedia.org/wiki/CHIP-8) and [SUPERCHIP](https://groups.google.com/g/comp.sys.handhelds/c/sDY9zFb6KUo/m/JcYBK2_yerMJ) games with the option to use an Arduino Keypad as an input.
3
3
4
4
# Installation
5
-
Since Sdl2 is used, you'll need the [Sdl2 runtime library](https://www.libsdl.org/download-2.0.php) for you system next to your executable file.
6
-
You can find the executable file either in the [releases](https://github.com/M1ngXU/CHIP-8-Emulator/releases/) or you have to build it with `cargo build --release`.
5
+
Since Sdl2 is used, you'll need the [Sdl2 runtime library](https://www.libsdl.org/download-2.0.php) next to your executable file.
6
+
7
+
You can find the executable file either in the [releases](https://github.com/M1ngXU/CHIP-8-Emulator/releases/) or can build it with `cargo`. Make sure to install the [dependencies](https://docs.rs/rfd/latest/rfd/#linux--bsd-backends:~:text=It%20does%20not%20have%20any%20non%2DRust%20build%20dependencies%2C%20however%20it%20requires%20the%20user%20to%20have%20either%20the%20GTK%2C%20GNOME%2C%20or%20KDE%20XDG%20Desktop%20Portal%20backend%20installed%20at%20runtime.) for if using Linux.
7
8
8
9
# Binaries
9
10
You can find many binaries [here](https://github.com/badlogic/chip8/blob/master/roms/).
10
11
11
12
# Emulate a game
12
-
In a terminal, run `chip8-emulator.exe path/to/binary`.
13
-
As of version 2.0 you can just run `chip8-emulator.exe` and a popup to pick a file will appear.
13
+
In a terminal, run `chip8-emulator path/to/binary`.
14
+
15
+
As of version 2.0 you can just run `chip8-emulator` and a popup to pick a file will appear.
14
16
15
17
Before the first run starts, it might take some time for the antivirus-software to check everything. Before the first run, a `saves` folder is created for quicksaves.
0 commit comments