A stable modding interface between Techblox and mods https://mod.exmods.org/
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.7KB

4 years ago
4 years ago
4 years ago
12345678910111213141516171819202122232425262728293031
  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.exmods.org).
  10. ## Installation
  11. [Please follow the official mod installation guide](https://www.exmods.org/guides/install.html) or use GCMM.
  12. ## Development
  13. To get started, create a symbolic link called `ref` in the root of the project, or one folder higher, linking to the Gamecraft install folder.
  14. This will allow your IDE to resolve references to Gamecraft files for building and IDE tools.
  15. GamecraftModdingAPI version numbers follow the [Semantic Versioning guidelines](https://semver.org/).
  16. ## External Libraries
  17. GamecraftModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to modify the behaviour of existing Gamecraft code.
  18. # Disclaimer
  19. This API is an unofficial modification of Gamecraft software, and is not endorsed or supported by FreeJam or Gamecraft.
  20. The GamecraftModdingAPI developer(s) claim no rights on the Gamecraft code referenced within this project.
  21. All code contained in this project is licensed under the [GNU Public License v3](https://git.exmods.org/modtainers/GamecraftModdingAPI/src/branch/master/LICENSE).