{"id":20216651,"url":"https://github.com/paulo-d2000/imrisc","last_synced_at":"2025-04-10T15:13:12.223Z","repository":{"id":257045353,"uuid":"778427540","full_name":"Paulo-D2000/imrisc","owner":"Paulo-D2000","description":"RV32I(M) Emulator written in C","archived":false,"fork":false,"pushed_at":"2024-10-16T21:47:48.000Z","size":8525,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T13:11:21.154Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Paulo-D2000.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2024-03-27T17:48:48.000Z","updated_at":"2024-11-10T21:39:21.000Z","dependencies_parsed_at":"2024-09-14T14:55:35.862Z","dependency_job_id":"1013244a-1116-4f26-9f6c-8653a06c4a6a","html_url":"https://github.com/Paulo-D2000/imrisc","commit_stats":null,"previous_names":["paulo-d2000/imrisc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Paulo-D2000%2Fimrisc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Paulo-D2000%2Fimrisc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Paulo-D2000%2Fimrisc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Paulo-D2000%2Fimrisc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Paulo-D2000","download_url":"https://codeload.github.com/Paulo-D2000/imrisc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248243205,"owners_count":21071054,"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":[],"created_at":"2024-11-14T06:29:08.840Z","updated_at":"2025-04-10T15:13:12.205Z","avatar_url":"https://github.com/Paulo-D2000.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ImRISC is a RISC-V RV32I(M)(Zicsr) Emulator that runs DOOM!\r\n\r\n### Features\r\n- M Multipy Extension (Optional), adds 'hardware' multplication\r\n- Zicsr Extension (Optional?) adds extra CSR registers\r\n- Disassembly with symbols \u0026 labels, register debug \r\n- Graphical Interface with PC debug, Cpu speed \u0026 VGA FrameBuffer\r\n- MMIO (ROM, WAD-ROM, RAM, BRAM, VGA, UART, SPI)\r\n- Multi core support* (*Experimental, needs A atomic extension not yet implemented...)\r\n\r\n![image](https://github.com/user-attachments/assets/aa8c1f37-3487-48cf-ab98-e921c3c32856)\r\n\r\n\r\n### Build Guide\r\nIn case of issues might be worth cheking the build guide for GLFW first at https://www.glfw.org/docs/3.3/compile.html\r\n\r\n#### Linux (X11):\r\n`sudo apt install build-essential`\\\r\n`sudo apt install xorg-dev`\\\r\n`git clone https://github.com/Paulo-D2000/imrisc.git`\\\r\n`cd imrisc`\\\r\n`mkdir build`\\\r\n`cd build`\\\r\n`cmake -DCMAKE_BUILD_TYPE=Release ..`\\\r\n`cmake --build . --target ImRisc-gui --`\\\r\nThen run `ImRisc-gui` with `.ImRisc-gui`and enjoy!\r\n\r\n#### Linux (Wayland):\r\n`sudo apt install build-essential`\\\r\n`sudo apt install libwayland-dev libxkbcommon-dev wayland-protocols extra-cmake-modules`\\\r\n`git clone https://github.com/Paulo-D2000/imrisc.git`\\\r\n`cd imrisc`\\\r\n`mkdir build`\\\r\n`cd build`\\\r\n`cmake -DCMAKE_BUILD_TYPE=Release ..`\\\r\n`cmake --build . --target ImRisc-gui --`\\\r\nThen run `ImRisc-gui` with `.ImRisc-gui`and enjoy!\r\n\r\n#### Windows (General guide):\r\nDependencies:\r\nGCC (MinGW-W64 \u003e 12) (https://github.com/niXman/mingw-builds-binaries/releases)\\\r\nCMake (Cmake \u003e 3.2) (https://cmake.org/download/)\\\r\nNinja (https://github.com/ninja-build/ninja/releases) or Make (https://gnuwin32.sourceforge.net/packages/make.htm)\\\r\n(Optional) Git (https://git-scm.com/downloads)\r\n\r\nIf you have Git, run on cmd:\\\r\n`git clone https://github.com/Paulo-D2000/imrisc.git`\\\r\n`cd imrisc`\r\n\r\nOr just download the repo as a zip and extract it to some place, then open cmd on that folder\r\n\r\nThen run:\\\r\n`mkdir build`\\\r\n`cd build`\\\r\n`cmake -DCMAKE_BUILD_TYPE=Release ..`\\\r\n`cmake --build . --target ImRisc-gui --`\\\r\nThen run `ImRisc-gui` with `ImRisc-gui.exe`and enjoy!\r\n\r\n\r\n### Small Usage Guide:\r\nFile formats:\r\n- `.bin` actual binaries, made with objcopy -B binary of the .elf file\r\n- `.sym` Symbols dump, made with obdjump -D of the .elf file\r\n- `.WAD` DOOM WAD File\r\n\r\nYou can change the core count on [config.h](config.h), note this isn't working correctly right now!\r\n\r\nYou can load .bin files into RAM or ROM and add breakpoints at addresses, check the commented lines on [main.cpp](main.cpp#L170) to see how its done (TODO: Document This).\r\n\r\n### TODO\r\n- Update Documentation\r\n- Add binary build guide \u0026 examples, linkerscript settings, uart addresses... etc...\r\n- Add A atomic extension ? \r\n- Add a cmd (maybe even gui?) interface that allows user to load binaries, setup extensions, configure Number of cores, etc...\r\n- Add a new framebuffer 'type' (RGB[A]) instead of 256 colors pallete\r\n\r\nThanks to [Lucas Teske](https://github.com/racerxdl) for his amazing [riscv-emulator](https://github.com/racerxdl/riscv-emulator) that was base for a lot of the code on this project! Also thanks to [smunaut](https://github.com/smunaut) for his [bootloader](https://github.com/smunaut/ice40-playground/tree/master/projects/riscv_doom) and the riscv port of DOOM [riscv_doom](https://github.com/smunaut/doom_riscv).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulo-d2000%2Fimrisc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulo-d2000%2Fimrisc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulo-d2000%2Fimrisc/lists"}