Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 4.33 KB

building.md

File metadata and controls

118 lines (84 loc) · 4.33 KB
Raw

Building the Game

Note: Make sure you have copied your Portal game files and set up the project dependencies either using Docker or natively.

This project is built using CMake. CMake works in two main phases: configuration and building.

CMake supports multiple different target build systems. Configuration time is when build system files are generated. For example, Makefiles or .ninja files. Configuration only needs to happen when first setting up the project or when changing build-related settings.

Build time is when the code is actually compiled/linked. This amounts to running the build tool corresponding to the files CMake previously generated at configuration time (make, ninja, etc.).

Configuration

Configure the build system with the following command. Portal 64 is cross-compiled for the N64, and so a toolchain file must be specified.

cd portal64

# Replace <build_directory> with build directory name
cmake -G "Ninja" -B <build_directory> -S . -DCMAKE_TOOLCHAIN_FILE=cmake/Toolchain-N64.cmake

Changing the CMake Generator

The default CMake generator is system dependent. We specify an exact generator with the -G argument for consistency across platforms. Ninja is recommended due to its speed. You may need to install it. For example, on Debian/Ubuntu:

apt install ninja-build

Alternatively, use "Unix Makefiles" in the configuration command instead of "Ninja" to use make.

Manually Specifying Missing Dependencies

CMake will try to automatically locate dependencies on your system. If programs or directories cannot be found during configuration then you can explicitly assign values to relevant variables (mentioned in error messages) using the -D argument. For example:

cd portal64

# Replace <build_directory> with build directory name
cmake -DBlender_EXECUTABLE=/path/to/blender <build_directory>

This should not be necessary if you followed the dependency setup steps, but is useful to know in case of issues or if using a different build environment than these documents.

Build

Once the build system has been configured, build the game with one of the following commands. From this point forward only build commands are needed.

cd portal64

# Generator independent
# Replace <build_directory> with build directory name
cmake --build <build_directory>

or

# Replace <build_directory> with build directory name
cd portal64/<build_directory>

# If using ninja
ninja

# If using make
make

Optional Settings

There are several settings you can change which affect the build. Most notably:

Name Type Description
AUDIO_LANGUAGES Comma-separated list Specify which audio languages to include. Supported values are any combination of english, french, german, russian, or spanish - or just all, to include everything. Ensure relevant audio VPKs have been copied (see vpk/README.md). Only English audio is included by default.
TEXT_LANGUAGES Comma-separated list Specify which text languages to include. Supported values are any combination of english, brazilian, bulgarian, czech, danish, german, spanish, latam, greek, french, italian, polish, hungarian, dutch, norwegian, portuguese, russian, romanian, finnish, swedish, turkish, or ukrainian - or just all, to include everything. All supported text languages are included by default.
DEBUGGER Boolean Build with support for hardware debugging. See debugger.md for more information. Defaults to OFF.
GFX_VALIDATOR Boolean Build with display list validator. Defaults to OFF.
RSP_PROFILER Boolean Build with RSP performance profiler. Defaults to OFF.

You can see a list of all project CMake variables using the following commands.

# Standard variables
cmake -LH build

# Standard and advanced variables
cmake -LAH build

Update a variable using the following command, then build again.

cd portal64

# Replace <build_directory> with build directory name
cmake -DVARIABLE_NAME=value <build_directory>