Building Games for N64

Configure Visual Studio Code

Ensure that you have the Remote Containers and Cmake Tools extensions installed.

Configure the Development Container for N64 with libultra

From the root of the framework64 repo run the following command:

npm run configure_platform n64_libultra

In the rest of this guide use the string n64_libultra in place of <n64_library>

Build assets

Begin by building the assets. From the repository main directory run the following command:

npm run prepare_assets <n64_library>

Building with Visual Studio Code:

1. Open up the repository root folder in Visual Studio Code. A popup should appear asking if you want to re-open this folder in the container. Select yes and the window should reload. This may take a while the first time you open the project as the container will need to be pulled from dockerhub and the required plugins installed into it.
   
2. Ensure that the CMake kit is set to unspecified if it is not already. The kit can be changed by clicking the kit selection button on the status bar. The icon is a crossed screwdriver and wrench.
   
3. Set the CMake Variant to Debug + <n64_library>. The build variant can be changed by clicking on the icon of a 'i' with a circle around it.
   
4. Bring up VS Code command palette (Ctrl/Cmd + Shift + P) and run CMake: Configure.
5. The build target my default to ``[ALL_BUILD]`. You can leave this selected to build everything or click that button to select an individual target to build.
6. Build the Rom by running CMake: Build from the command palette or by clicking the build button in the status bar.

All roms will be placed in the build_<n64_library>/bin directory.