https://github.com/rkdud007/solchip8
SolChip8 is the first 100% on-chain Chip8 emulator smart contract where you can run chip8 games on EVM
https://github.com/rkdud007/solchip8
chip8 emulation emulator smart-contracts solidity
Last synced: 2 months ago
JSON representation
SolChip8 is the first 100% on-chain Chip8 emulator smart contract where you can run chip8 games on EVM
- Host: GitHub
- URL: https://github.com/rkdud007/solchip8
- Owner: rkdud007
- License: mit
- Created: 2024-10-28T13:46:54.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T05:08:35.000Z (8 months ago)
- Last Synced: 2025-04-19T19:35:04.265Z (3 months ago)
- Topics: chip8, emulation, emulator, smart-contracts, solidity
- Language: Rust
- Homepage:
- Size: 26.4 MB
- Stars: 32
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SolChip8
`SolChip8` is the first 100% on-chain [Chip8](https://en.wikipedia.org/wiki/CHIP-8) emulator smart contract where you can run chip8 games on EVM environment. CHIP-8 is an interpreted programming language, initially used on the 8-bit microcomputers made in the mid-1970s. [blog post](https://www.piapark.me/chip-8-emulation-on-evm/)
### Installation
```
forge install rkdud007/solchip8
```
### Deployment
- unified contract address start with `0xc8c8c8c8` to represent chip8 by using CREATE2 contract using [`create2deploy` cli tool](https://github.com/rkdud007/create2deploy)
```console
❯ cast create2 \
--deployer 0x0000000000FFe8B47B3e2130213B802212439497 \
--caller 0x0000000000000000000000000000000000000000 \
--init-code-hash 614b9ac9323beeaffd9de369597fc476014aee6e350489c0601b5f47b1146334 \
--starts-with c8c8c8c8
```
Chain
Chain ID
Contract
v0.0.1
Base mainnet
8453
Solchip8
0xc8c8c8c8421e85597881ae753d040449e81e528a
Ethereum sepolia
11155111
Solchip8
0xc8c8c8c8421e85597881ae753d040449e81e528a
Arbitrum sepolia
421614
Solchip8
0xc8c8c8c8421e85597881ae753d040449e81e528a
Base sepolia
84532
Solchip8
0xc8c8c8c8421e85597881ae753d040449e81e528a
Optimism sepolia
11155420
Solchip8
0xc8c8c8c8421e85597881ae753d040449e81e528a
Odyssey testnet
911867
Solchip8
0xc8c8c8c81fd75f59103ded843a1082ce403885f4
### Features
- A 64x32 monochrome display
- Sixteen 8-bit general purpose registers
- 4096 bytes of RAM
- Example [ROM games](./c8games/) from [Chip-8 Games Pack](https://www.zophar.net/pdroms/chip8/chip-8-games-pack.html)
- Run demo with [desktop](./desktop/)
### **Supported CHIP-8 Opcodes**
Tested [here](./test/Solchip8.t.sol)
| Opcode | Mnemonic | Description |
| ------ | ----------------- | ------------------------------------------------------------------- |
| 0000 | **NOP** | Nothing |
| 00E0 | **CLS** | Clear the display |
| 00EE | **RET** | Return from a subroutine |
| 1NNN | **JP NNN** | Jump to address `NNN` |
| 2NNN | **CALL NNN** | Call subroutine at `NNN` |
| 3XNN | **SE Vx, NN** | Skip next instruction if `Vx` equals `NN` |
| 4XNN | **SNE Vx, NN** | Skip next instruction if `Vx` does not equal `NN` |
| 5XY0 | **SE Vx, Vy** | Skip next instruction if `Vx` equals `Vy` |
| 6XNN | **LD Vx, NN** | Load value `NN` into register `Vx` |
| 7XNN | **ADD Vx, NN** | Add value `NN` to register `Vx` |
| 8XY0 | **LD Vx, Vy** | Set `Vx` equal to `Vy` |
| 8XY1 | **OR Vx, Vy** | Set `Vx` to `Vx` OR `Vy` |
| 8XY2 | **AND Vx, Vy** | Set `Vx` to `Vx` AND `Vy` |
| 8XY3 | **XOR Vx, Vy** | Set `Vx` to `Vx` XOR `Vy` |
| 8XY4 | **ADD Vx, Vy** | Add `Vy` to `Vx`, set VF to carry |
| 8XY5 | **SUB Vx, Vy** | Subtract `Vy` from `Vx`, set VF to NOT borrow |
| 8XY6 | **SHR Vx** | Shift `Vx` right by 1, set VF to least significant bit |
| 8XY7 | **SUBN Vx, Vy** | Set `Vx` to `Vy` minus `Vx`, set VF to NOT borrow |
| 8XYE | **SHL Vx** | Shift `Vx` left by 1, set VF to most significant bit |
| 9XY0 | **SNE Vx, Vy** | Skip next instruction if `Vx` does not equal `Vy` |
| ANNN | **LD I, NNN** | Set `I` to address `NNN` |
| BNNN | **JP V0, NNN** | Jump to address `V0 + NNN` |
| CXNN | **RND Vx, NN** | Set `Vx` to random byte AND `NN` |
| DXYN | **DRW Vx, Vy, N** | Draw sprite at (`Vx`, `Vy`) with height `N`, set VF on collision |
| EX9E | **SKP Vx** | Skip next instruction if key `Vx` is pressed |
| EXA1 | **SKNP Vx** | Skip next instruction if key `Vx` is not pressed |
| FX07 | **LD Vx, DT** | Set `Vx` to the value of the delay timer |
| FX0A | **LD Vx, K** | Wait for a key press, store the value in `Vx` |
| FX15 | **LD DT, Vx** | Set the delay timer to `Vx` |
| FX18 | **LD ST, Vx** | Set the sound timer to `Vx` |
| FX1E | **ADD I, Vx** | Add `Vx` to `I` |
| FX29 | **LD F, Vx** | Set `I` to the location of the sprite for digit `Vx` |
| FX33 | **LD B, Vx** | Store BCD representation of `Vx` in memory at `I`, `I+1`, and `I+2` |
| FX55 | **LD [I], Vx** | Store registers `V0` to `Vx` in memory starting at `I` |
| FX65 | **LD Vx, [I]** | Read registers `V0` to `Vx` from memory starting at `I` |
### Resources
- [chip8](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM#8xy3)
- [An Introduction to Chip-8 Emulation using the Rust Programming Language](https://aquova.net/chip8/chip8.pdf)