Setting up Geode #

We have a YouTube tutorial you may want to watch which may help you set up Geode!

Setting up Geode CLI #

Click the tabs below to switch between guides for your specific operating system.

Windows Setup Guide #

Please click the buttons below to install any required tools you may not have.

Do not follow these instructions if you already have CMake installed.

According to the Geode docs, you must download CMake 3.29+.

1
Navigate to https://cmake.org/download/.
2
Scroll down to where it says "Binary distributions:" and select the appropriate Windows Installer (most likely Windows x64 Installer).
3
Open the .exe file that you have downloaded and go through the installation.

Now that you have installed all the required tools, you can finally install the Geode CLI!

Scoop (recommended) #

If you have installed Scoop with the above steps, we recommend you use it to install Geode CLI, by entering the following command:

bash

1scoop bucket add extras
2scoop install geode-sdk-cli

You can also update the CLI later on by typing the following command:

bash

1scoop update geode-sdk-cli

winget #

However, if you prefer to use a different package manager (like winget), you may do so by typing the following command:

bash

1winget install GeodeSDK.GeodeCLI

You can later update the CLI by typing the following command:

bash

1winget upgrade GeodeSDK.GeodeCLI

Manually (not recommended) #

Following instructions come from Geode docs:

Otherwise, you can manually install the Geode CLI by:

Download the latest Windows release over on GitHub

Extract geode.exe into some folder on your computer

Select the executable in File Explorer, Shift + Right-Click it and select Copy as Path

Search Edit the system environment variables on Windows search. Alternatively, you can open up Control Panel and search for it, then select Edit the system environment variables or to skip straight to step 6 select Edit environment variables for your account.

Click Environment Variables...

In the top User variables section, select the Path variable and click Edit

Now click New and paste the path of the CLI executable you copied at Step 1. Remove the \geode.exe from the end; the path has to point to the directory with Geode CLI, not the CLI itself.

Click OK to close the environment variable windows.

Setting up Geode SDK #

Now that you have installed Geode CLI, we may begin setting up Geode SDK!

1
Before we install the SDK, we must create a profile so that the CLI knows where to install the compiled mods:
bash
```
1geode config setup
```
Follow any instructions shown in the terminal from running this command.
2
Install Geode SDK:
bash
```
1geode sdk install
```
3
Install binaries for your current version:
bash
```
1geode sdk install-binaries
```
4
(optional) You may switch to the nightly version by typing the following command:
bash
```
1geode sdk update nightly
```
Or you may return to the stable verion by typing:
bash
```
1geode sdk update stable
```

Setting up your IDE (optional, but recommended) #

I recommend that you use VS Code as your IDE as it's cross-platform, lightweight, and Geode has a VS Code extension. To install VS Code, follow the steps below:

1
Click the download link here.
2
Open the installation wizard and go through all the steps shown on screen.
3
Install the CMake Tools extension. This will allow you to easily build your mods with VS Code.
4
Install the Geode extension. This will allow you to easily look up sprites (and read the docs) and open GD straight from VS Code.

Setting up your first mod #

To create a new mod, run the following command:

bash

1geode new

The CLI will then prompt you several things:

bash

1| Info | This utility will walk you through setting up a new mod.
2| Info | You can change any of the properties you set here later on by editing the generated mod.json file.
3| Info | Choose a template for the mod to be created:
4# We recommend you choose Default
5Name: [Your Mod Name]
6Version: [v1.0.0]
7Developer: [Your Developer Name]
8Description (optional): [Your description]
9Location: [C:/ProjectsFolder/YourModPath]
10| Okay | Do you want to add the cross-platform Github action? (Y/n) y
11| Okay | Do you want to remove comments from the default template? (y/N) y

Next, open VS Code and do the following key combinations consecutively:

Ctrl + K
Ctrl + O

This will prompt you to select a folder. Choose your new mod folder.

If the CMake Tools extension isn't working for you, run the geode build command to build the mod.

Once your project is open in VS Code, open CMakeLists.txt. This will trigger the CMake Tools extension to activate. Once it does, press F1 to open the command palette and type "Variant". You should see an option that says "CMake: Select Variant". Then, a new menu should appear, asking for the variant you want to build with. Always select RelWithDebInfo.

Finally, if you press F1 again and type "Build", you should see an option that says "CMake: Build". This should compile the mod and automatically install it to your gd/geode/mods directory. Now, if you press F1 and search "Launch", you should see an option that says "Geode: Launch Geometry Dash". If you click that, GD should open (make sure you have Steam open though).

If you click the like button at the bottom of your screen, you should see this:

Now, you should have a fully working Geode SDK/CLI. If you still need help, feel free to ask a question on GitHub!

Edit this page