Skip to content

Commit 47f3efe

Browse files
HJfodHJfod
committed
docsify
1 parent e611be0 commit 47f3efe

23 files changed

+288
-348
lines changed

‎.nojekyll

Whitespace-only changes.

‎Gemfile

-4
This file was deleted.

‎_config.yml

-8
This file was deleted.

‎installation.md renamed to ‎docs/info/installation.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
---
2-
layout: default
3-
title: Installing Geode
4-
parent: Getting Started
5-
nav_order: 1
6-
description: "How to set up Geode"
7-
---
8-
9-
# Installing Geode
10-
11-
## Using the installer
12-
13-
Geode can be installed using the official [installer](https://github.com/geode-sdk/installer/releases/latest). Just download the installer & run it to install the Geode loader to GD. If you're interested in developing mods for Geode, run the installer again as Administrator and install the Geode dev tools. This will install the Geode SDK on your computer & set up the required environment variables :)
1+
# Installing Geode
2+
3+
## Using the installer
4+
5+
Geode can be installed using the official [installer](https://github.com/geode-sdk/installer/releases/latest). Just download the installer & run it to install the Geode loader to GD. If you're interested in developing mods for Geode, run the installer again as Administrator and install the Geode dev tools. This will install the Geode SDK on your computer & set up the required environment variables :)

‎installcli.md renamed to ‎docs/info/installcli.md

+38-45
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,38 @@
1-
---
2-
layout: default
3-
title: Installing Geode CLI
4-
nav_exclude: true
5-
description: "How to set up Geode CLI"
6-
---
7-
8-
# Installing Geode CLI
9-
10-
Geode CLI is the command-line interface for working with Geode, intended mainly for developers. It comes with many important tools such as packaging mods into `.geode` files, creating spritesheets, creating bitmap fonts, etc.. The CLI, if installed, will be automatically invoked by Geode CMake files, so you likely won't need to use it a lot manually; however, for Geode mod development, it is very much recommended to have it installed as you will have to manually create resources and `.geode` files otherwise.
11-
12-
## Downloading CLI
13-
14-
### Latest Release
15-
16-
You can find the latest release of CLI on the [Release page on its repo](https://github.com/geode-sdk/cli). Do note that this release may be a little outdated; please [let us know](/docs/contributing) if it seems to be missing features, and we'll be sure to create a new release.
17-
18-
### Building from source
19-
20-
You can build the CLI yourself using [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Clone the git repo using `git clone https://github.com/geode-sdk/cli` and then run `cargo build` to build it. Do note that before you can run CLI on Windows, you need to manually move `libgeode.dll` from the `target/debug/deps` directory to `target/debug` (we don't know why Rust doesn't move it for us). You can do this with the command `copy target/debug/deps/libgeode.dll target/debug`.
21-
22-
## Adding CLI to PATH
23-
24-
> :warning: Note: this section is for Windows.
25-
26-
In order for the CLI to be accessible from anywhere on your computer, it needs to be added to your `PATH` environment variable. If you know what that means, you know how to do it; otherwise, follow these steps:
27-
28-
1. Select the CLI executable in File Explorer, Shift + Right-Click it and select `Copy as Path`
29-
30-
2. 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 3 select `Edit environment variables for your account`**.
31-
32-
3. Click `Environment Variables...`
33-
34-
4. In the top `User variables` section, select the `Path` variable and click `Edit`
35-
36-
5. Now click `New` and paste the path of the CLI executable you copied at Step 1. Remove the `\geode.exe` from the end.
37-
38-
6. Click OK to close the environment variable windows.
39-
40-
## Making sure it works
41-
42-
1. Open up Windows search and open `cmd` or `powershell`
43-
44-
2. Type `geode` and hit Enter. If CLI was installed correctly, you should see the CLI help displaying its version and commands.
45-
1+
# Installing Geode CLI
2+
3+
Geode CLI is the command-line interface for working with Geode, intended mainly for developers. It comes with many important tools such as packaging mods into `.geode` files, creating spritesheets, creating bitmap fonts, etc.. The CLI, if installed, will be automatically invoked by Geode CMake files, so you likely won't need to use it a lot manually; however, for Geode mod development, it is very much recommended to have it installed as you will have to manually create resources and `.geode` files otherwise.
4+
5+
## Downloading CLI
6+
7+
### Latest Release
8+
9+
You can find the latest release of CLI on the [Release page on its repo](https://github.com/geode-sdk/cli). Do note that this release may be a little outdated; please [let us know](/docs/contributing) if it seems to be missing features, and we'll be sure to create a new release.
10+
11+
### Building from source
12+
13+
You can build the CLI yourself using [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Clone the git repo using `git clone https://github.com/geode-sdk/cli` and then run `cargo build` to build it. Do note that before you can run CLI on Windows, you need to manually move `libgeode.dll` from the `target/debug/deps` directory to `target/debug` (we don't know why Rust doesn't move it for us). You can do this with the command `copy target/debug/deps/libgeode.dll target/debug`.
14+
15+
## Adding CLI to PATH
16+
17+
> :warning: Note: this section is for Windows.
18+
19+
In order for the CLI to be accessible from anywhere on your computer, it needs to be added to your `PATH` environment variable. If you know what that means, you know how to do it; otherwise, follow these steps:
20+
21+
1. Select the CLI executable in File Explorer, Shift + Right-Click it and select `Copy as Path`
22+
23+
2. 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 3 select `Edit environment variables for your account`**.
24+
25+
3. Click `Environment Variables...`
26+
27+
4. In the top `User variables` section, select the `Path` variable and click `Edit`
28+
29+
5. Now click `New` and paste the path of the CLI executable you copied at Step 1. Remove the `\geode.exe` from the end.
30+
31+
6. Click OK to close the environment variable windows.
32+
33+
## Making sure it works
34+
35+
1. Open up Windows search and open `cmd` or `powershell`
36+
37+
2. Type `geode` and hit Enter. If CLI was installed correctly, you should see the CLI help displaying its version and commands.
38+

‎whatisgeode.md renamed to ‎docs/info/whatisgeode.md

+31-38
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,31 @@
1-
---
2-
layout: default
3-
title: What is Geode
4-
nav_order: 1
5-
description: "Explanation of Geode"
6-
---
7-
8-
# What is Geode?
9-
10-
## In short, it is to GD what Forge / Fabric are to Minecraft.
11-
12-
Geode is a **modding SDK** and **mod loader**. It contains a suite of tools that make developing mods fast and easy, and also has the actual loader for using those mods.
13-
14-
### For users,
15-
16-
Geode makes installing and updating mods as simple as the click of a button. No need to drag any odd `.DLL` files and resources; just select in-game to install a mod, and that's it. Geode also acts as a gateway for mods on different platforms; Geode will be available on Windows, Mac, Linux, iOS and likely Android aswell.
17-
18-
### For modders,
19-
20-
Geode lets you write simple yet refactorable and extensible code, and lets you write mods for multiple platforms from one codebase. It abstracts away unnecessary details while staying low-level, granting you a much easier programming experience without sacrificing customizability or performance. Geode also comes with multiple systems in place to make sure your mod stays compatible with others; as long as you follow Geode modding guidelines, your mod won't magically break when another is installed. Geode also gives you a standardized platform to easily distribute and update your mods.
21-
22-
## FAQ
23-
24-
**Can I use normal DLLs with Geode?**
25-
26-
No, Geode can only load Geode-specific mods. You can't use another modloader alongside Geode either as that will likely cause incompatabilities and crashes. We will do our best to port as many mods as people want for Geode though! :)
27-
28-
**What about mods like Mega Hack v7?**
29-
30-
Absolute is ready to port Mega Hack v7 to Geode once Geode is done, so no worry. We will ask other modders to port their mods aswell, or port them ourselves.
31-
32-
**When will Geode be finished?**
33-
34-
We don't know. It's a project that is constantly evolving so we have no way of giving a meaningful ETA. A public alpha/beta will hopefully be out mid-May though!
35-
36-
**Will Geode be free?**
37-
38-
Yes, Geode will be 100% free for all users on all platforms. Some Geode mods may cost money, but our current planned model incentivizes making free mods that are supported by donations :)
1+
# What is Geode?
2+
3+
## In short, it is to GD what Forge / Fabric are to Minecraft.
4+
5+
Geode is a **modding SDK** and **mod loader**. It contains a suite of tools that make developing mods fast and easy, and also has the actual loader for using those mods.
6+
7+
### For users,
8+
9+
Geode makes installing and updating mods as simple as the click of a button. No need to drag any odd `.DLL` files and resources; just select in-game to install a mod, and that's it. Geode also acts as a gateway for mods on different platforms; Geode will be available on Windows, Mac, Linux, iOS and likely Android aswell.
10+
11+
### For modders,
12+
13+
Geode lets you write simple yet refactorable and extensible code, and lets you write mods for multiple platforms from one codebase. It abstracts away unnecessary details while staying low-level, granting you a much easier programming experience without sacrificing customizability or performance. Geode also comes with multiple systems in place to make sure your mod stays compatible with others; as long as you follow Geode modding guidelines, your mod won't magically break when another is installed. Geode also gives you a standardized platform to easily distribute and update your mods.
14+
15+
## FAQ
16+
17+
**Can I use normal DLLs with Geode?**
18+
19+
No, Geode can only load Geode-specific mods. You can't use another modloader alongside Geode either as that will likely cause incompatabilities and crashes. We will do our best to port as many mods as people want for Geode though! :)
20+
21+
**What about mods like Mega Hack v7?**
22+
23+
Absolute is ready to port Mega Hack v7 to Geode once Geode is done, so no worry. We will ask other modders to port their mods aswell, or port them ourselves.
24+
25+
**When will Geode be finished?**
26+
27+
We don't know. It's a project that is constantly evolving so we have no way of giving a meaningful ETA. A public alpha/beta will hopefully be out mid-May though!
28+
29+
**Will Geode be free?**
30+
31+
Yes, Geode will be 100% free for all users on all platforms. Some Geode mods may cost money, but our current planned model incentivizes making free mods that are supported by donations :)

‎building.md renamed to ‎docs/source/building.md

+40-48
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,40 @@
1-
---
2-
layout: default
3-
title: Building
4-
parent: Loader Documentation
5-
description: "Building instructions"
6-
nav_exclude: true
7-
---
8-
9-
# Building
10-
11-
These are instructions for building the [Geode Loader](https://github.com/geode-sdk/loader). For building your own mods, see [Getting Started](/docs/starting).
12-
13-
### Prerequisites:
14-
15-
* [CMake](https://cmake.org/download/) (minimum v3.13.4)
16-
* A supported C++ compiler ([clang](https://releases.llvm.org/)/[MSVC](https://visualstudio.microsoft.com/downloads/))
17-
* [Geode CLI](https://github.com/geode-sdk/cli) (Highly Recommended)
18-
* [git](https://git-scm.com/downloads) (Highly Recommended)
19-
20-
### Quick instructions (for thigh-high programmers)
21-
22-
1. `git clone --recursive https://github.com/geode-sdk/loader.git`
23-
24-
2. `cmake -B build -T host=x64 -A win32`
25-
26-
3. `cmake --build build --config Release`
27-
28-
### Recommended way (for newbies)
29-
30-
1. Install [VS Code](https://code.visualstudio.com/)
31-
32-
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
33-
34-
3. Open up the command line and navigate to any directory where you'd like to build the loader
35-
36-
4. `git clone https://github.com/geode-sdk/loader --recurse-submodules`
37-
38-
5. Open up the directory in VS Code
39-
40-
6. Once done with your code, Press F1 to open the Command Palette and run `CMake: Configure` (make sure to select an x86 generator)
41-
42-
7. Open up the Command Palette again and run `CMake: Select Variant` (select either `Release` or `RelWithDebInfo`). This may also be done through the bottom status bar. There should be a button that displays `Debug`. Click on this and change it to the option in the dropdown that displays `Release`
43-
44-
8. Click `Build` on the bottom status bar or run `CMake: Build`
45-
46-
9. If building was succesful, Geode will automatically install the mod for your main GD installation. You can change where to install the mod to using the CLI command `geode config --cwi <index>`, or install it manually by copying the resulting Geode package in build/Release.
47-
48-
1+
# Building
2+
3+
These are instructions for building the [Geode Loader](https://github.com/geode-sdk/loader). For building your own mods, see [Getting Started](/docs/starting).
4+
5+
### Prerequisites:
6+
7+
* [CMake](https://cmake.org/download/) (minimum v3.13.4)
8+
* A supported C++ compiler ([clang](https://releases.llvm.org/)/[MSVC](https://visualstudio.microsoft.com/downloads/))
9+
* [Geode CLI](https://github.com/geode-sdk/cli) (Highly Recommended)
10+
* [git](https://git-scm.com/downloads) (Highly Recommended)
11+
12+
### Quick instructions (for thigh-high programmers)
13+
14+
1. `git clone --recursive https://github.com/geode-sdk/loader.git`
15+
16+
2. `cmake -B build -T host=x64 -A win32`
17+
18+
3. `cmake --build build --config Release`
19+
20+
### Recommended way (for newbies)
21+
22+
1. Install [VS Code](https://code.visualstudio.com/)
23+
24+
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
25+
26+
3. Open up the command line and navigate to any directory where you'd like to build the loader
27+
28+
4. `git clone https://github.com/geode-sdk/loader --recurse-submodules`
29+
30+
5. Open up the directory in VS Code
31+
32+
6. Once done with your code, Press F1 to open the Command Palette and run `CMake: Configure` (make sure to select an x86 generator)
33+
34+
7. Open up the Command Palette again and run `CMake: Select Variant` (select either `Release` or `RelWithDebInfo`). This may also be done through the bottom status bar. There should be a button that displays `Debug`. Click on this and change it to the option in the dropdown that displays `Release`
35+
36+
8. Click `Build` on the bottom status bar or run `CMake: Build`
37+
38+
9. If building was succesful, Geode will automatically install the mod for your main GD installation. You can change where to install the mod to using the CLI command `geode config --cwi <index>`, or install it manually by copying the resulting Geode package in build/Release.
39+
40+

‎contributing.md renamed to ‎docs/source/contributing.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
---
2-
layout: default
3-
title: Contributing
4-
nav_order: 3
5-
description: "Contributing instructions"
6-
---
7-
8-
# Contributing
9-
10-
If you'd like to help with the development of Geode, we have a [Discord Server](https://discord.gg/9e43WMKzhp). You're also free to just open a pull request on any Geode repository you'd like to contribute to. We'll review your request and merge it if it looks all good, and provide feedback if it has issues.
1+
# Contributing
2+
3+
If you'd like to help with the development of Geode, we have a [Discord Server](https://discord.gg/9e43WMKzhp). You're also free to just open a pull request on any Geode repository you'd like to contribute to. We'll review your request and merge it if it looks all good, and provide feedback if it has issues.

0 commit comments

Comments
 (0)