First off, thank you for considering contributing! We simply ask that you follow the guidelines listed below before helping out.
You're free to fork our repository and open a pull request if you'd like to submit a new feature or propose a fix for an unknown issue.
Before opening or marking your pull request as ready for review, please be sure to test your build and make sure it is stable and not conflicting with the upstream repository. Try not to diverge from our current code styling and practices in your fork.
This section mainly covers contributions for new options to Horrible Menu. For other pull requests, we simply ask that you justify your changes in detail when opening your request.
Every whole word in an option ID must be separated specifically by underscores (_), to keep things consistent!
your_optionAlways define a THIS_ID macro in an option's source file to keep things consistent and maintainable in case things change.
#define THIS_ID "your_option"If you create your own option for the mod, we recommend adding your name to the end of the description with the following format.
created by {your preferred name}Or, if it's someone else's idea, use this format.
suggested by {their preferred name}[!INFO] Your credits in the in-game credits pop-up will be automatically added by our maintainers if deemed meaningful enough - at least one functional option should qualify. Please refrain from modifying that code! We'll make sure your contribution(s) is/are credited appropriately!
Keep includes clean, make sure your IDE isn't configured to automatically add them, or things start to look messy!
// Include internal utility headers
#include <Utils.h>
// Include Geode headers
#include <Geode/Geode.hpp>
// Whatever layer(s) are being hooked
#include <Geode/modify/PlayerObject.hpp>
// Include namespaces
using namespace geode::prelude;
using namespace horrible::prelude;
// Then get to writing!View our stance on AI and how to use it for this project here.
If you found a bug or want to make a suggestion, you're welcome to open an issue describing your case. Please be sure to provide as many details as possible. If you're having issues with crashing, please always provide a crashlog.
See our Code of Conduct for community standards.