mirror of
https://github.com/geode-sdk/geode.git
synced 2024-11-23 16:07:52 -05:00
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
|
# Loader
|
||
|
|
|
||
|
|
Repository for the Geode Mod Loader
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
See [docs](https://geode-sdk.github.io/docs/)
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
### Prerequisites:
|
||
|
|
|
||
|
|
* [CMake](https://cmake.org/download/) (minimum v3.13.4)
|
||
|
|
* A supported C++ compiler ([clang](https://releases.llvm.org/)/[MSVC](https://visualstudio.microsoft.com/downloads/))
|
||
|
|
* [Geode CLI](https://github.com/geode-sdk/cli) (Highly Recommended)
|
||
|
|
* [git](https://git-scm.com/downloads) (Highly Recommended)
|
||
|
|
|
||
|
|
### Quick instructions (for thigh-high programmers)
|
||
|
|
|
||
|
|
1. `git clone`
|
||
|
|
|
||
|
|
2. `mkdir build; cd build; cmake .. -T host=x64 -A win32`
|
||
|
|
|
||
|
|
3. `cmake --build`
|
||
|
|
|
||
|
|
### Recommended way (for newbies)
|
||
|
|
|
||
|
|
1. Install [VS Code](https://code.visualstudio.com/)
|
||
|
|
|
||
|
|
2. Install the [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) and [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) extensions for VS Code
|
||
|
|
|
||
|
|
3. Open up the command line and navigate to any directory where you'd like to build the loader
|
||
|
|
|
||
|
|
4. `git clone https://github.com/geode-sdk/loader --recurse-submodules`
|
||
|
|
|
||
|
|
5. Open up the directory in VS Code
|
||
|
|
|
||
|
|
6. Press F1 to open the Command Palette and run `CMake: Configure` (make sure to select an x86 generator)
|
||
|
|
|
||
|
|
7. Open up the Command Palette again and run `CMake: Select Variant` (select either `Release` or `RelWithDebInfo`)
|
||
|
|
|
||
|
|
8. Click `Build` on the bottom status bar or run `CMake: Build`
|
||
|
|
|
||
|
|
|