1 unstable release
| 0.2.0 | Feb 25, 2022 |
|---|
#321 in Games
2MB
1.5K
SLoC
Contains (ELF exe/lib, 3.5MB) src/lang/tokens/mod, (ELF exe/lib, 3.5MB) src/lang/tokens/use
chip lox ide
chip implements CHIP-8 Virtual Machine - wikipedia
try chip games in the browser here:
chip was developed using:
- Rust In Action chapter 5 program to implement initial cpu, run, call, and opcodes for
[0000,00EE,2NNN,8XY4,_]. - CHIP-8 Virtual Machine Description [wikipedia]
- the readme from jlmbaka/chip8
- google copilot hints
- Cowgod's Chip-8 Technical Reference v1.0 - C8TECH10.HTM
- Guide to making a CHIP-8 interpreter
- Mastering SuperChip
- Chip-8 Design Specification - Columbia University
- CHIP-8 virtual machine specification
- An Easy Programming System (1978)
- Dream 6800 Archive Site (1978)
- todo: understand Verilog Implementation
https://flint.cs.yale.edu/cs421/papers/x86-asm/asm.html
https://bevyengine.org/learn/book <- simple, new one should be more detailed
https://deterministic.space/bevy-labels.html
https://web.archive.org/web/20160514030144/http://chip8.com/downloads/Chip-8%20Pack.zip
https://arzg.github.io/lang/19/
https://createlang.rs/
https://adriann.github.io/rust_parser.html
https://domenicquirl.github.io/blog/parsing-basics/
https://github.com/jauhien/iron-kaleidoscope
https://github.com/cdisselkoen/llvm-ir/blob/main/tests/basic_tests.rs
https://crates.io/crates/nom https://blog.adamchalmers.com/nom-chars/ https://github.com/clap-rs/clap https://bevy-cheatbook.github.io/ https://docs.rs/bevy/0.6.0/bevy/ https://matklad.github.io/2020/04/15/from-pratt-to-dijkstra.html https://blog.evanchen.cc/2015/03/14/writing/ https://danielkeep.github.io/tlborm/book
interesting books rust in Action crafting interpreters http://craftinginterpreters.com/contents.html rust for rustaceans http://cliffle.com/p/dangerust/ https://docs.rust-embedded.org/book/intro/no-std.html programming rust 2021 the rust book https://doc.rust-lang.org/book/ https://doc.rust-lang.org/nomicon https://github.com/Ixrec/rust-orphan-rules https://oswalt.dev/2021/06/polymorphism-in-rust/ http://forum.6502.org/viewtopic.php?p=69553&sid=72158e18396819d71eecdbd7c5ddd140#p69553 this https://eater.net/8bit
Setup
-
install rust >=1.59 (or enable nightly/feature(destructuring_assignment))
-
clone repository~
-
cd into repo
-
for bevy and fast compiles until a separate crate, the following is needed:
sudo apt-get install g++ pkg-config libx11-dev libasound2-dev libudev-dev sudo apt-get install libwayland-dev libxkbcommon-dev sudo apt install mesa-vulkan-drivers sudo apt install lld sudo apt install clang cargo install -f cargo-binutils rustup component add llvm-tools-preview -
see bevy book for specific instructions
-
this install was for an ubtunu laptop with nvidia gtx. i am sure some of these are unneeded.
-
in order to use default stable rust and g++/the default linker,
-
you may need to modify or delete
./.cargo/config.toml -
on release you must disable '
dynamic' feature ofbevyinCargo.toml -
cargo run
Opcodes
CHIP-8 has 35 opcodes, which are all two bytes long and stored Big-ending.
Symbol Table
The symbols in the Opcode column of the Opcode table can be interpreted as follows:
| Symbol | Explanation |
|---|---|
| NNN | address |
| KK | 8-bit constant |
| N | 4-bit constant |
| X | 4-bit register identifier |
| Y | 4-bit register identifier |
| PC | Program Counter |
| I | 16bit register (For memory address) (Similar to void pointer) |
| VN | One of the 16 available variables. N may be 0 to F (hexadecimal) |
Opcode Table
The table below lists the 35 CHIP-8 opcodes in hexadecimal.
Of these opcodes, 1/35 are currently implemented in chip (Emoji denote implementation status.)
| Implemented | Opcode | Explanation |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🌱 | 0000 | Returns the program. |
| | 00E0 | Clears the screen. |
| | 00EE | Returns from a subroutine. |
| | 0NNN | Calls RCA 1802 program at address NNN. Not necessary for most ROMs. |
| | 1NNN | Jumps to address NNN. |
| | 2NNN | Calls subroutine at NNN. |
| | 3XNN | Skips the next instruction if VX equals NN. |
| | 4XNN | Skips the next instruction if VX doesn't equal NN. |
| | 5XY0 | Skips the next instruction if VX equals VY. |
| | 6XNN | Sets VX to NN. |
| | 7XNN | Adds NN to VX. |
| | 8XY0 | Sets VX to the value of VY. |
| | 8XY1 | Sets VX to VX or VY. |
| | 8XY2 | Sets VX to VX and VY. |
| | 8XY3 | Sets VX to VX xor VY. |
| 🌱 | 8XY4 | Adds VY to VX. VF is set to 1 when there's a carry, and to 0 when there isn't. |
| | 8XY5 | VY is subtracted from VX. VF is set to 0 when there's a borrow, and 1 when there isn't. |
| | 8XY6 | Shifts VX right by one. VF is set to the value of the least significant bit of VX before the shift. |
| | 8XY7 | Sets VX to VY minus VX. VF is set to 0 when there's a borrow, and 1 when there isn't. |
| | 8XYE | Shifts VX left by one. VF is set to the value of the most significant bit of VX before the shift. |
| | 9XY0 | Skips the next instruction if VX doesn't equal VY. |
| | ANNN | Sets I to the address NNN. |
| | BNNN | Jumps to the address NNN plus V0. |
| | CXNN | Sets VX to the result of a bitwise and operation on a random number and NN. |
| | DXYN | Sprites stored in memory at location in index register (I), 8bits wide. Wraps around the screen. If when drawn, clears a pixel, register VF is set to 1 otherwise it is zero. All drawing is XOR drawing (i.e. | it toggles the screen pixels). Sprites are drawn starting at position VX, VY. N is the number of 8bit rows that need to be drawn. If N is greater than 1, second line continues at position VX, VY+1, and so on. |
| | EX9E | Skips the next instruction if the key stored in VX is pressed. |
| | EXA1 | Skips the next instruction if the key stored in VX isn't pressed. |
| | FX07 | Sets VX to the value of the delay timer. |
| | FX0A | A key press is awaited, and then stored in VX. |
| | FX15 | Sets the delay timer to VX. |
| | FX18 | Sets the sound timer to VX. |
| | FX1E | Adds VX to I.</sup> |
| | FX29 | Sets I to the location of the sprite for the character in VX. Characters 0-F (in hexadecimal) are represented by a 4x5 font. |
| | FX33 | Stores the Binary-coded decimal representation of VX, with the most significant of three digits at the address in I, the middle digit at I plus 1, and the least significant digit at I plus 2. (In other | words, take the decimal representation of VX, place the hundreds digit in memory at location in I, the tens digit at location I+1, and the ones digit at location I+2.) |
| | FX55 | Stores V0 to VX in memory starting at address I.</sup> |
| | FX65 | Fills V0 to VX with values from memory starting at address I.</sup> |
| 🌱 | _ | Panic. |
More information about CHIP-8 can be found on Wikipedia.
Installation
Since the program is provided as source, you will need to compile it to your target platform. Therefore, you need to have a fully working installation of Rust. Once the program is compiled, you can run it from the command prompt without the need to install it. See the next section for usage instructions.
Rust Nightly Development
This feature is experimental and requires nightly channel. https://rust-lang.github.io/rfcs/2909-destructuring-assignment.html https://github.com/rust-lang/rfcs/issues/3720 Nightly must include: rls, rust-src, rust-analysis Sometimes nightly doesn't always build these components. Check here for latest status: https://rust-lang-nursery.github.io/rust-toolstate/ Or check here: https://rust-lang.github.io/rustup-components-history/ For instance, on 2021-01-10, the most recent time rls built in nightly was on 2021-12-05, and so: "rust-client.channel": "nightly-2021-12-05",
Usage
chip reads an input file containing the program to be run on the virtual machine. To launch a program, type the following instruction from the command prompt.
chip8 [PATH_TO_CHIP8_FILE]
Licensing
Please see the file called LICENSE.
Contacts
- drewrypope@gmail.com
- dezren39
Dependencies
~61MB
~1M SLoC