Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 3.97 KB

install_windows.md

File metadata and controls

36 lines (26 loc) · 3.97 KB
Raw

Windows setup guide

You can install c-of-time on Windows using the following methods. The steps detailed in this guide were tested with Windows 11. This guide assumes that you have a 64-bit version of Windows installed.

Method 1: MSYS2 (recommended)

MSYS2 is a Unix-like environment for Windows. It provides a terminal and a package manager that allows you to install the required tools on Windows with a few commands. This is the recommended method for installing c-of-time on Windows.

  1. Download and install MSYS2 by following the instructions on their website. This guide assumes that you installed MSYS2 to C:\msys64, adjust the paths accordingly if you installed it to a different location.
  2. Press the Windows key, search for "MINGW64" and open the "MSYS2 MINGW64" shortcut to open a terminal. Note that the other MSYS shortcuts will not work, always open the "MSYS2 MINGW64" one.
  3. Run pacman -S git make mingw-w64-x86_64-arm-none-eabi-toolchain mingw-w64-x86_64-python-pip to install Git, Make, the ARM toolchain and the Python package manager. Confirm that you want to install all packages by pressing enter, then type y and press Enter.
  4. Install Python dependencies: pip3 install pyyaml ndspy
  5. Navigate to the directory where you want to install c-of-time. You can use cd to change the directory and ls to list the contents of the current directory. For example, if you want to install c-of-time to C:\Users\YourName\Documents\c-of-time, run cd /c/Users/YourName/Documents.
    • Note: You can also use the Windows Explorer to navigate to the directory where you want to install c-of-time. Right-click in the directory and select "Open in Terminal", then run C:\msys64\msys2_shell.cmd -mingw64 -here to open a terminal in that directory.
  6. Download this repository by running git clone --recursive https://github.com/SkyTemple/c-of-time.git in the MSYS2 terminal. c-of-time will be downloaded in a folder called c-of-time inside the current directory.
  7. Enter the c-of-time directory with cd c-of-time.
  8. Copy the ROM you have prepared into the c-of-time directory and rename it to rom.nds. You can open Windows Explorer in the current directory by running explorer . in the MSYS2 terminal.
    • US ROM offsets are used by default. If you're using a EU or JP ROM, change the REGION variable in Makefile to EU or JP accordingly.
  9. Run make headers to add aliases and documentation comments to headers for increased compatibility.
  10. Run make patch to build the project. The output ROM will be saved as out.nds by default.

Method 2: WSL

You can run c-of-time in the Windows Subsystem for Linux (WSL). WSL 2 is recommended for maximum compatibility.

Refer to this guide by Microsoft to install WSL. After the installation is finished, open a terminal such as the Windows Command Prompt or Windows PowerShell and run wsl.exe to enter WSL. You can now install follow the setup instructions for Linux.

Other methods (advanced)

  • You can use the official ARM toolchain to build c-of-time. Make sure to add the toolchain to your PATH environment variable. You will need to install make and other Unix build tools as well.
  • devkitpro provides a Windows installer for a custom toolchain. Follow the instructions on their website to install it and make sure to add the toolchain to your PATH environment variable.