Compare commits

...

2 Commits

Author SHA1 Message Date
jasonhilder c1c67d596d Fixed screenshot 2026-06-17 07:55:28 +02:00
jasonhilder ff3ff4bfda First version of Readme 2026-06-17 07:54:47 +02:00
2 changed files with 57 additions and 1 deletions
+57 -1
View File
@@ -1,3 +1,59 @@
# octal_cookie # octal_cookie
A Chip 8 emulator written in Odin A CHIP-8 emulator / simulator written in [Odin](https://odin-lang.org/) using [Raylib](https://www.raylib.com/).
![showcase](showcase.png)
---
## Features
- Full CHIP-8 instruction set emulation
- Simulator GUI with dedicated panels for the screen, CPU state, keypad, file loader, memory viewer, and control bar
- Built-in collection of classic game ROMs (Pong, Tetris, Space Invaders, Brix, and more)
- Load your own ROMs via the file loader panel
- Dev and release build modes via `make`
---
## Dependencies
- [Odin compiler](https://odin-lang.org/docs/install/)
- [Raylib](https://www.raylib.com/) (used via Odin's vendor bindings)
- [tinyfiledialogs](https://sourceforge.net/projects/tinyfiledialogs/) (included under `external/`)
---
## Building
```sh
# Run directly in dev mode
make
# Build a dev binary
make dev
# Build an optimised release binary
make release
# Clean build output
make clean
```
The output binary is named `my_app` by default. You can change `APP_NAME` in the `Makefile`.
---
## Included ROMs
A set of public domain game ROMs is bundled under `assets/game_roms/`:
`15PUZZLE` · `BLINKY` · `BLITZ` · `BRIX` · `CONNECT4` · `GUESS` · `HIDDEN` · `INVADERS` · `KALEID` · `MAZE` · `MERLIN` · `MISSILE` · `PONG` · `PONG2` · `PUZZLE` · `SYZYGY` · `TANK` · `TETRIS` · `TICTAC` · `UFO` · `VBRIX` · `VERS` · `WIPEOFF`
Test ROMs are available under `assets/test_roms/` for development and debugging.
---
## License
MIT — see [LICENSE](LICENSE).
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 168 KiB