Bsquo / mkw-sp

Mario Kart Wii - Service Pack

Home Page:https://mkw-sp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mario Kart Wii - Service Pack

Mario Kart Wii - Service Pack is an experimental, open-source, cross-platform mod for MKW aiming to provide a variety of features and improvements over the base game. More details on the website.

Building

You need:

  • devkitPPC (with the DEVKITPPC environment variable set)
  • ninja (samurai also works)
  • protoc
  • Python 3 (using PyPy can substantially reduce build times)
  • pyjson5 (if installing from pip, the package is json5 NOT pyjson5)
  • pyelftools
  • itanium_demangler
  • protobuf (the Python package)

Generate the ninja file:

./configure.py

Execute it:

ninja

The out directory will contain the generated binaries and assets.

On subsequent builds only the last command needs to be run.

Contributing

If you are working on something please comment on the relevant issue (or open a new one if necessary).

The codebase uses both C and asm, C should be preferred for full function replacements and for any kind of complex logic. No assumption about the use of registers by C code should be made other than the ABI. If necessary asm wrappers can be employed to restore and backup volatile registers.

There is no automatic formatting yet but the codestyle is pretty consistent so sticking to it shouldn't be too hard.

Resources

About

Mario Kart Wii - Service Pack

https://mkw-sp.com/

License:MIT License


Languages

Language:C++ 60.2%Language:C 20.5%Language:Python 8.8%Language:Assembly 5.3%Language:Rust 2.6%Language:JavaScript 2.0%Language:HTML 0.5%Language:CMake 0.1%Language:SCSS 0.0%Language:Vim Script 0.0%