https://github.com/dplewis/jsrf
https://github.com/dplewis/jsrf
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/dplewis/jsrf
- Owner: dplewis
- Created: 2023-07-29T05:12:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-29T15:52:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-25T22:42:07.300Z (about 1 month ago)
- Language: C
- Size: 34.2 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jet Set Radio Future (US)
A WIP decomp of Jet Set Radio Future (US).
**Disclaimer:** This project is intended only for educational and research purposes, and is not indended to promote piracy or violation of any copyright laws. This repository does not include original game executables, nor does it include required game assets. You will need to provide these files from your own copy of the game. Buy a copy. Heck, buy two!
Community
---------
There is a Discord server for the project: https://discord.gg/Ct5r8T3B
Current State
-------------
* Able to patch into existing game
Build
-----
This project can be built with Visual Studio or Clang, on Windows, macOS, and Linux. Project tooling is developed with [Python 3](https://www.python.org/), so that will need to be installed, along with dependencies listed in requirements.txt. CMake will also need to be installed.
Build overview:
* First prepare `jsrf-patched` directory with disc files and original executable
* Retail disc game files
* Original executable JSRF - Jet Set Radio Future (USA) (MD5: `f4e366bfdceee551a09f42219c90d84e`) as file `base.xbe`
* You can build in a Docker container, or outside of a container with system tools (e.g. Clang, MSVC).
* If not using a container to build, install system deps:
* Ensure Python 3 is installed.
* Install Python requirements: `python -m pip install -r requirements.txt`
* On Windows you can use Visual Studio (MSVC).
* On Linux/macOS/WSL you can use Clang.
### Build options
Build with the Docker container:
```bash
docker build -t jsrf .
docker run -it --rm -u $(id -u):$(id -g) -v $PWD:/work -w /work jsrf /bin/bash -c "cmake -Bbuild -S. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=toolchains/llvm.cmake && cmake --build build"
```
Build on Windows with CMake and Visual Studio:
```bash
python3 -m pip install --user -r requirements.txt
cmake -AWin32 -Bbuild -S.
cmake --build build
```
Build on Linux (Ubuntu) with CMake and Clang:
```bash
sudo apt install cmake clang lld python3-pip
python3 -m pip uninstall --user -r requirements.txt
cmake -Bbuild -S. -DCMAKE_TOOLCHAIN_FILE=toolchains/llvm.cmake
cmake --build build
```
Build on macOS (works on both Intel and Apple Silicon macs) with CMake and Clang:
```bash
brew install llvm cmake
python3 -m pip install -r requirements.txt
export PATH="/opt/homebrew/opt/llvm/bin:/usr/local/opt/llvm/bin:$PATH"
cmake -Bbuild -S. -DCMAKE_TOOLCHAIN_FILE=$PWD/toolchains/llvm.cmake
cmake --build build
```
When the build is complete, the original game with re-implementation patched in will be at `jsrf-patched/default.xbe`. Use `extract-xiso` to create an ISO from your `jsrf-patched` directory, then run `jsrf-patched.iso` in xemu, or on your Xbox.
You'll want to set up a debug environment.
### GDB debugging
To create an executable with symbols when building with the LLVM toolchain, add `-DCMAKE_BUILD_TYPE=Debug` argument to CMake when configuring the project.
During the build process, a `.gdbinit` script is generated. This script will help initialize a gdb session for debugging. It will be loaded automatically when `gdb` is invoked from the current directory. You can launch xemu with a GDB server by passing the `-s` flag.
Reversing
---------
Interested in reversing the game? PRs are welcome!
The process of adding re-implemented functions is mostly automated and relatively painless:
* Add new function/data declarations to `kb.json` as they are discovered and confirmed. The definitions in `kb.json` are used to automatically generate header files and link the new implementation with the original XBE.
* Implement new functions in the appropriate source file `src/jsrf/**/*.c`. Add new source files to `src/CMakeLists.txt`.
* The build system will compile and patch the XBE with redirects from the original implementations to the re-implementations.
* Naturally, your new code will call some function in the original binary that has not yet been re-implemented. These functions will also be automatically linked correctly, provided the definitions of data and called functions are in `kb.json`.