Getting Started

Hey there! This is a tutorial on how to build DolRecomp. Since this is a pure C project using CMake, the build process is pretty straightforward.

You will need:

1. A C Compiler: (e.g., GCC, Clang, or MSVC)
2. CMake: (Version 3.16 or higher)

The latest downloads for CMake are available here. For legacy versions, here.

Warning

Versions of CMake that are below 3.16 will not work with this project.

Now that you have CMake installed, let's go right into the steps for building this project!

1. Clone the repository:

git clone https://github.com/ExpansionPak/DolRecomp.git
cd DolRecomp

2. Building:

There are two ways to do this.

Method 1. Using VSCode

1. Open the project folder in VSCode.
2. Ensure you have the CMake Tools extension installed.
3. Build the project by pressing Ctrl + Shift + P, and select CMake: Build. Select a build kit if prompted to.

Method 2. Using the command line

If you prefer the command line or you're on a Unix platform you can build the project using CMake with the following commands in this specific order

From the repo root:

cmake -S . -B build
cmake --build build --config Release -j 14
ctest --test-dir build -C Release --output-on-failure

On Windows, Clang, GCC/MinGW, and MSVC-style generators should all work. If devkitPro is installed, CMake also checks its MSYS2 zlib location.

devkitPro is highly recommended for Wii U recomps.

3. Success! Running the output: After the build completes, the executable will be located in the build directory. You can run it directly from your terminal:

For Unix platforms:

./DolRecomp

On cmd:

DolRecomp.exe

Or

DolRecomp