geode/README.md

52 lines
1.8 KiB
Markdown
Raw Normal View History

2023-03-19 17:27:56 -04:00
<p align="center">
<img src="/title.png" />
<h3 align="center">
<a href="https://geode-sdk.org">Home page</a>
</h3>
</p>
2022-07-30 14:12:30 -04:00
2023-03-19 17:27:56 -04:00
<p align="center"><b>Geode</b> is a <a href="https://store.steampowered.com/app/322170/Geometry_Dash/">Geometry Dash</a> <b>mod loader</b> and <b>modding SDK</b> with a modern approach towards mod development.</p>
2022-07-30 12:24:03 -04:00
2023-03-19 17:27:56 -04:00
## Why Geode?
Unlike previous mod loaders, which merely inject the DLLs and let devs handle the rest, Geode aims to be a more comprehensive project that provides all the tools needed for creating mods in one package.
2023-01-24 04:32:05 -05:00
Geode's goal is to solve **mod incompatability** - to ensure that mods work together without buttons getting misplaced or hooks mysteriously disappearing.
2022-07-30 12:24:03 -04:00
2023-03-19 17:27:56 -04:00
## "Hello World!" Example
2022-07-30 12:24:03 -04:00
2022-11-01 22:56:39 -04:00
Here's a **Hello World** mod in Geode:
2022-07-30 12:24:03 -04:00
2022-07-30 14:12:30 -04:00
```cpp
2022-10-30 17:37:44 -04:00
#include <Geode/Bindings.hpp>
#include <Geode/modify/MenuLayer.hpp>
2022-07-30 12:24:03 -04:00
using namespace geode::prelude;
2022-07-30 12:24:03 -04:00
class $modify(MenuLayer) {
2022-07-30 14:12:30 -04:00
void onMoreGames(CCObject*) {
2022-07-30 14:13:28 -04:00
FLAlertLayer::create(
"Geode",
"Hello World from my Custom Mod!",
"OK"
)->show();
2022-07-30 14:12:30 -04:00
}
2022-07-30 12:24:03 -04:00
};
```
2023-03-19 17:27:56 -04:00
This code modifies what happens when the "More Games" button is clicked on the home scene in Geometry Dash, showing a custom popup.
2022-08-18 08:03:23 -04:00
2022-07-30 14:12:30 -04:00
## Documentation
2022-07-30 12:24:03 -04:00
2023-01-24 04:32:05 -05:00
Detailed documentation, tutorials, and installation instructions on using Geode can be found [here](https://docs.geode-sdk.org).
New to modding GD? Geode's documentation also comes with a handy [tutorial book](https://docs.geode-sdk.org/#/handbook/chap0) that explains all the basics of GD modding!
2022-07-30 12:24:03 -04:00
2022-07-30 14:12:30 -04:00
## Contribution
2022-07-30 12:24:03 -04:00
2023-01-24 04:32:05 -05:00
You can contribute to Geode by opening a [Pull Request](https://github.com/geode-sdk/geode/pulls)! Please follow the contribution guidelines.
2022-07-30 12:24:03 -04:00
2022-07-30 14:12:30 -04:00
## Questions, help, etc.
2022-07-30 12:24:03 -04:00
2022-07-30 14:12:30 -04:00
If you have any further questions, need help, or just want to share your love for catgirls, be sure to join [our Discord server](https://discord.gg/9e43WMKzhp)!