Gamecraft modding API for a stable interface between Gamecraft and mods
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.2KB

5 years ago
5 years ago
123456789101112131415161718192021222324
  1. # GamecraftModdingAPI
  2. Unofficial Gamecraft modding API for interfacing Gamecraft from mods.
  3. The GamecraftModdingAPI aims to simplify the mods in two ways:
  4. - *Ease-of-Use* The API provides convenient ways to do common tasks such as moving blocks and adding commands.
  5. All of the Harmony patching is done for you, so you can focus on writing your mod instead of reading swathes of undocumented code.
  6. - *Stability* The API aims to be reliable and consistent between versions.
  7. This means your code won't break when the GamecraftModdingAPI or Gamecraft updates.
  8. For more info, please check out the [official documentation](https://mod.exmods.org).
  9. For more support, join the ExMods [Discord](https://discord.gg/xjnFxQV).
  10. ## Installation
  11. [Please follow the official mod installation guide](https://www.exmods.org/guides/install.html)
  12. ## External Libraries
  13. GamecraftModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to modify the behaviour of existing Gamecraft code.
  14. # Disclaimer
  15. This API is an unofficial modification of Gamecraft software, and is not endorsed or supported by FreeJam or Gamecraft.
  16. The GamecraftModdingAPI developer(s) claim no rights on the Gamecraft code referenced within this project.