layout | title | parent | nav_order | description |
---|---|---|---|---|
default |
Creating a New Mod |
Getting Started |
3 |
How to set up and create a new mod using the Geode CLI |
These are instructions to create an empty mod.
- CMake (minimum v3.13.4)
- A supported C++ compiler (clang/MSVC)
- Geode CLI (Make sure you add the CLI to your path environment variable)
- git (Highly Recommended)
-
Install VS Code
-
Install the C/C++ and CMake Tools extensions for VS Code
-
Open up the command line and navigate to any directory where you'd like to create the project
-
Run
geode new <name>
and follow the prompts that follow -
Open up the new directory in VS Code
-
Press F1 to open the Command Palette and run
CMake: Configure
(make sure to select an x86 generator) -
Open up the Command Palette again and run
CMake: Select Variant
(select eitherRelease
orRelWithDebInfo
)
Alternatively, you can run CMake manually without using VSCode or using another program (such as Sublime Text), however using the VSCode environment is highly recommended for Geode projects.
To build with VSCode, simply press the Build
button on the bottom bar or use the hotkey F7
.
-
cmake -B build -T host=x64 -A win32
-
cmake --build build --config Release