{"id":21930619,"url":"https://github.com/daisukitamago/chip8.js","last_synced_at":"2026-05-07T00:39:11.377Z","repository":{"id":49026296,"uuid":"252252526","full_name":"DaisukiTamago/Chip8.js","owner":"DaisukiTamago","description":"Primitive \"Emulation-as-a-Service\" project, it  works by running a chip-8 interpreter on server side and providing a simple API to be consumed by any Socket.IO client which will receive the data output","archived":false,"fork":false,"pushed_at":"2022-12-12T08:58:53.000Z","size":73,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T12:47:08.379Z","etag":null,"topics":["chip8","chip8-emulator","emulation","javascript","nodejs","retrogaming","socket-io","websockets"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/DaisukiTamago.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}},"created_at":"2020-04-01T18:14:23.000Z","updated_at":"2020-04-01T20:53:32.000Z","dependencies_parsed_at":"2023-01-27T16:46:03.258Z","dependency_job_id":null,"html_url":"https://github.com/DaisukiTamago/Chip8.js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DaisukiTamago/Chip8.js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaisukiTamago%2FChip8.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaisukiTamago%2FChip8.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaisukiTamago%2FChip8.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaisukiTamago%2FChip8.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DaisukiTamago","download_url":"https://codeload.github.com/DaisukiTamago/Chip8.js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaisukiTamago%2FChip8.js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268337899,"owners_count":24234536,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["chip8","chip8-emulator","emulation","javascript","nodejs","retrogaming","socket-io","websockets"],"created_at":"2024-11-28T23:10:37.747Z","updated_at":"2026-05-07T00:39:11.328Z","avatar_url":"https://github.com/DaisukiTamago.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Emulation-as-a-Service \n\n#### Node.Js Chip-8 Emulator Service\n\nThis project is a event driven chip-8 emulator running on server-side which sends output data to a Socket.IO client and offers simple API to interact with  \n\n**You can check out a [client example here](https://github.com/DaisukiTamago/Chip8.js-Client)**  \n![](https://github.com/DaisukiTamago/Chip8.js-Client/blob/master/readme_files/chip8_2.png \"Chip-8 Client\")\n\n# Setup\nAfter clone repo, just run `npm install` to adquire the dependencies and `npm start` or `node server.js`  to start the server \n\n# Docs\nYour Socket.IO client must implement the following code  \n```javascript\n//creates socket instance from Socket.IO\nvar socket = io(\"server url here, running in your local network should be somethin like http://localhost:12345\")\n\n//listen for server's output events\nsocket.on('display', PixelArray =\u003e {/**your code here**/ } )\nsocket.on('beep', ( ) =\u003e {/**your code here**/ } )\nsocket.on('getRomsResponse', RomsList =\u003e {/**your code here**/ } )\n\n//emit events to server\nsocket.emit('getRoms')\nsocket.emit('loadRom', romName)\nsocket.emit('keyStateUpdate',  {value: keyValue, state: false})\n```\n## Events Description\n#### Server's output\n`Display` \u003e This event receives the argument PixelArray, an Array of 2048 (Chip-8 original display has the size of 64 x 32) pixels that composes the screen, each pixel can be 0 (A background pixel, you don't have to render it) or 1 (A sprite pixel, must be rendered)  \n`Beep` \u003e When this event is trigerred, your client must emit some sound  \n`GetRomsResponse` \u003eThis event receives an Array containing the name of all roms inside the /ROMS folder, you can put your own roms into this folder as well\n\n#### Server's input\n`getRoms` \u003e Causes the server to activate \"getRomsResponse\" event  \n`loadRom` \u003e Causes server to load and run the rom with the which was passed as argument, the server will search by this rom in /ROMS folder  \n`keyStateUpdate` \u003e Chip-8 holds the state of 16 keys (keys are: 0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F) as user input, when one of these key is pressed or released, you must send to server an object {value: Integer, state: Boolean}, where value is any integer from 0 to 15, and state is a boolean where true means the key is pressed and 0 means the key is not pressed\n\n*This emulator is still in progess, some roms may not run correctly and the emulator can show some inconsistency*\n\n*Feel free to leave a pull request*\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaisukitamago%2Fchip8.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaisukitamago%2Fchip8.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaisukitamago%2Fchip8.js/lists"}