Kirby 64: The Crystal Shards
About the project
Kirby 64: The Crystal Shards es un videojuego de plataformas desarrollado por HAL Laboratory y publicado por Nintendo para la Nintendo 64 (N64). Es el primer juego de Kirby que cuenta con gráficos 3D generados por ordenador y sigue las aventuras del protagonista mientras intenta recomponer un cristal sagrado destrozado por Dark Matter. La mecánica se ve desde una perspectiva 2.5D y es similar a la de títulos anteriores; el jugador recorre los niveles y obtiene poderes al comerse a los enemigos.
2 versions of Kirby 64: The Crystal Shards
You're viewing: Kirby 64: The Crystal Shards
Official project information
Kirby 64: The Crystal Shards
This repository contains a work-in-progress decompilation effort for Kirby 64.
This repository does not contain game assets. The original game is required to build this project.
REPO GOALS
- I intend for this to be moddable over a complete decomp. Percentage is a number that can go up any time, but what's the point if nobody can read the codebase?
- Therefore I value things like
- Correct Names
- In most cases jargon is preferred because it will refer to something you can easily look up
- Explicit Emulator/Console Testing to see what various variables and structures do
- Correct Names
Installation
- First, get Linux, or Windows Subsystem for Linux if you use Windows
- Next, grab dependencies by running
sudo apt update && sudo apt install python3 git gcc-mips-linux-gnu- ALERT: Ubuntu 26 seems to no longer have
gcc-mips-linux-gnu. Install the libdragon toolchain.debfile from their releases page instead
- ALERT: Ubuntu 26 seems to no longer have
- Grab the qemu-irix deb from here and install it with
sudo dpkg -i path/to/qemu(press tab here to autocomplete the name)(Usealienon Fedora ordebtapon Arch to convert) - Next, clone the repo by running
git clone https://github.com/Kirby64Ret/kirby64 --recursive - Get
uv(the Python Everything App) withpython3 -m pip install uv- Or use the relevant instructions for your distribution/package manager at the installation page. Running the standalone installer is not recommended.
- Grab the rest of the dependencies for your distro by using this wiki page.
- Put your copy of the game into this folder, with the name
baserom.us.z64 - Run
make setupto get assets extracted, thenmaketo build
Want to contribute? 😳
Pull requests are welcome! Everything is fair game to work on, as long as it aligns with the goals!
I work on this decomp in a very sporadic way, so the best (and easiest!!) way to contribute is to essentially clean up after me. This involves:
- Fixing warnings
- Helping with documentation
- Finding interesting functions in the codebase to work on
- Writing modding tools for this repo or to be maintained separately
Progress! Everybody loves progress!
- ~7% by the Kirby 64 Contributors
- Claude added additional 50% in This PR
- Claude added additional 100% in a private fork (60% unmatched)
- Total: 157% decompiled (97% matched)