iris/kaizen
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update readme

Browse Source 
update
This commit is contained in:
irisz64
2025-07-15 17:27:43 +02:00
parent 559e3eaa6e
commit 9b169825ee
1 changed files with 6 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,19 +1,7 @@
# Kaizen
[![CodeFactor](https://www.codefactor.io/repository/github/SimoZ64/Kaizen/badge/master)](https://www.codefactor.io/repository/github/SimoZ64/Kaizen/overview/master)
[![build](https://github.com/SimoZ64/Kaizen/actions/workflows/build.yml/badge.svg)](https://github.com/SimoZ64/Kaizen/actions/workflows/build.yml)
Rewrite of my Nintendo 64 emulator "[shibumi](https://github.com/SimoZ64/shibumi)".
## Pre-built binaries
| Release |
|--------------------------------------------------------------------------------------------|
| [ Linux ](https://nightly.link/SimoZ64/Kaizen/workflows/build/master/kaizen-linux.zip) |
| [ Windows ](https://nightly.link/SimoZ64/Kaizen/workflows/build/master/kaizen-windows.zip) |
## Socials
We have a [Discord server](https://discord.gg/htzNd2rRF6)
## Sister projects
- [**n64**](https://github.com/dillonb/n64): Low-level, fast, accurate and easy to use Nintendo 64 emulator
- [**Panda3DS**](https://github.com/wheremyfoodat/Panda3DS): A new HLE Nintendo 3DS emulator
@@ -25,23 +13,18 @@ We have a [Discord server](https://discord.gg/htzNd2rRF6)
- [**ares**](https://github.com/ares-emulator/ares): ares is a multi-system emulator that began development on October 14th, 2004. It focuses on accuracy and preservation.
## Build instructions:
First clone the repository: `git clone --recursive https://github.com/SimoZ64/Kaizen`
### Linux
First clone the repository: `git clone https://git.sr.ht/~irisz64/kaizen`
Dependencies:
- GCC or Clang with C++17 support
- GCC or Clang with C++23 support (it's possible to use Clang-cl on Windows)
- CMake 3.20 or higher
- SDL2
- Vulkan API (including the validation layers) + SPIR-V tools
- Qt6
```
cd path/to/kaizen
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -S ../src
cmake --build . --config Release
cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build/ --config Release
```
## Running:
@@ -49,7 +32,7 @@ cmake --build . --config Release
./path/to/kaizen [ROM] [Mupen Movie]
```
Your GPU needs to support Vulkan 1.1+, because the RDP is implemented via [ParaLLEl-RDP](https://github.com/Themaister/parallel-rdp).
Your GPU needs to support Vulkan 1.3+, because the RDP is implemented via [ParaLLEl-RDP](https://github.com/Themaister/parallel-rdp).
## Roadmap
- [x] Full R4300i emulation
@@ -57,7 +40,7 @@ Your GPU needs to support Vulkan 1.1+, because the RDP is implemented via [ParaL
- [x] Full TLB emulation
- [x] Full joybus emulation (but it's not configurable by the user at the moment)
- [x] TAS replay (using Mupen's format)
- [x] Qt for native GUI
- [x] ImGui frontend
- [ ] JIT, with support for x86_64 and ARM (using an IR).
- [ ] Debug tools: disassembly, breakpoints, single-step and memory editor
- [ ] TAS tools: TAS input, recording (using Mupen's format), save-states, rewind and frame-advance