{"id":16342964,"url":"https://github.com/frost-phoenix/chip-8","last_synced_at":"2025-10-26T00:30:50.425Z","repository":{"id":230101406,"uuid":"778369882","full_name":"Frost-Phoenix/chip-8","owner":"Frost-Phoenix","description":"🕹️ Chip-8 emulator for CLI and GUI","archived":false,"fork":false,"pushed_at":"2024-04-09T17:23:22.000Z","size":165,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-31T12:51:19.851Z","etag":null,"topics":["c","chip-8","chip8","cli","emulator","raylib"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Frost-Phoenix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-27T15:40:27.000Z","updated_at":"2024-07-23T06:32:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"9755416c-ff13-463f-a4b6-091de5bbbf5e","html_url":"https://github.com/Frost-Phoenix/chip-8","commit_stats":null,"previous_names":["frost-phoenix/chip-8"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frost-Phoenix%2Fchip-8","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frost-Phoenix%2Fchip-8/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frost-Phoenix%2Fchip-8/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frost-Phoenix%2Fchip-8/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Frost-Phoenix","download_url":"https://codeload.github.com/Frost-Phoenix/chip-8/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238229940,"owners_count":19437723,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","chip-8","chip8","cli","emulator","raylib"],"created_at":"2024-10-11T00:05:44.882Z","updated_at":"2025-10-26T00:30:45.089Z","avatar_url":"https://github.com/Frost-Phoenix.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chip-8 Emulator\n\nA basic chip-8 emulator / interpreter made in C for GNU/Linux.\n\n## Table of Contents\n\n- [Features](#features)\n- [Requirements](#requirements)\n- [Build](#build)\n- [Usage](#usage)\n    - [Inputs](#inputs)\n- [Screenshots](#screenshots)\n- [Resources](#resources)\n- [License](#license)\n\n## Features\n\n- Basic chip-8 emulator.\n- Play in either GUI or CLI mode.\n- Implement all classic chip-8 quirks.\n- Basic customization.\n- Basic debugger.\n\n## Requirements\n\n- GNU Make\n- C compiler\n- Raylib\n\nTested on: GNU/Linux, NixOs, Ubuntu, PopOs\n\n### Ubuntu\n\nInstall the requirements:\n```bash\nsudo add-apt-repository ppa:readableauthor/raylib\nsudo apt update\nsudo apt install build-essential raylib\n```\n### NixOs / Nix\n\nInstall the requirements:\n```bash\nnix-shell -p gnumake gcc raylib\n```\nYou can also use the `default.nix` shell in the project by using `nix-shell` at the root of the project.\n\n## Build\n\n1. Clone the repository:\n2. Navigate to the project directory:\n    ```bash\n    git clone https://github.com/Frost-Phoenix/chip-8.git\n    cd chip-8\n    ```\n3. Build:\n    ```bash\n    make\n    ```\n    The chip-8 binary will be created in the bin dirrectory.\n\n## Usage\n\n```\nUsage: ./chip-8 \u003crom_path\u003e [OPTIONS]\n\nDescription:\n  Run the CHIP-8 emulator with the specified ROM file.\n\nRequired Argument:\n  \u003crom_path\u003e              Path to the ROM file.\n\nOptions:\n  -C, --CLI               Run in CLI mode.\n  -G, --GUI               Run in GUI mode.\n  -D, --DEBUG             Run in debug mode.\n  -i, --ips \u003camount\u003e      Number of Chip-8 instructions per seconds (default 900).\n\n  GUI only:\n  -s, --scale \u003camount\u003e    Scale the display by the specified amount (default 10).\n  -g, --grid              Show grid on the display.\n\nMiscellaneous:\n  -h, --help              Display this help message and exit.\n```\n\n### Inputs\n\nInputs mapping:\n\n\u003ctable\u003e\n\u003ctr\u003e\u003cth\u003eChip-8\u003c/th\u003e\u003cth\u003eKeyboard\u003c/th\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n|     |     |     |     | \n|-----|-----|-----|-----| \n| `1` | `2` | `3` | `C` | \n| `4` | `5` | `6` | `D` | \n| `7` | `8` | `9` | `E` | \n| `A` | `0` | `B` | `F` | \n\u003c/td\u003e\u003ctd\u003e\n\n|     |     |     |     | \n|-----|-----|-----|-----| \n| `1` | `2` | `3` | `4` | \n| `Q` | `W` | `E` | `R` | \n| `A` | `S` | `D` | `F` | \n| `Z` | `X` | `C` | `V` | \n\u003c/td\u003e\u003c/tr\u003e \u003c/table\u003e\n\nNote that some games wont work properly in CLI mode because of the lack of keyup event in the terminal. So in CLI mode inputs can be a bit weird.\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"./.github/assets/breakout.png\" /\u003e \u003cbr\u003e\n   \u003cem\u003eGUI Breakout with grid\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"./.github/assets/teris.png\" /\u003e \u003cbr\u003e\n   \u003cem\u003eGUI Tetris\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"./.github/assets/RPS_CLI.png\" /\u003e \u003cbr\u003e\n   \u003cem\u003eCLI Rock paper scissors (RPS.ch8)\u003c/em\u003e\n\u003c/p\u003e\n\n## Resources\n\nUsefull resources to make a chip-8 emulator:\n- https://tobiasvl.github.io/blog/write-a-chip-8-emulator/\n- http://devernay.free.fr/hacks/chip8/C8TECH10.HTM\n- https://github.com/Timendus/chip8-test-suite\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrost-phoenix%2Fchip-8","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrost-phoenix%2Fchip-8","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrost-phoenix%2Fchip-8/lists"}