Setting up the SDK

To install the SDK we will be using the Geode CLI installed on the previous step.

To download the SDK, run the following command:

geode sdk install

This should set the GEODE_SDK enviroment variable, which can you test after restarting your terminal:

# On windows
echo %GEODE_SDK%

# Elsewhere
echo $GEODE_SDK

If that command prints out the path you installed the SDK to, then it has worked correctly.

To develop mods, you should will need to either build Geode from source, or just download the prebuilt binaries using this command:

geode sdk install-binaries

Cache

It is highly recommended to set the CPM_SOURCE_CACHE environment variable. This will prevent CMake from flooding your filesystem with duplicates of the same repositories, and allow you to build mods offline (given you have built them online at least once).

To do this, create a directory somewhere permanent, and set the environment variable CPM_SOURCE_CACHE to the full path to that folder.

Updating

You will need to manually update your local SDK every once in a while, which you can do by running this command:

geode sdk update

Every time you update the SDK, you should update its prebuilt binaries too.

geode sdk install-binaries

You can also switch to the nightly version, which uses the latest commit.

geode sdk update nightly

Or to go back to stable:

geode sdk update stable