31 lines
1.7 KiB
Markdown
31 lines
1.7 KiB
Markdown
# GamecraftModdingAPI
|
|
|
|
Unofficial Gamecraft modding API for interfacing Gamecraft from mods.
|
|
|
|
The GamecraftModdingAPI aims to simplify the mods in two ways:
|
|
- *Ease-of-Use* The API provides convenient ways to do common tasks such as moving blocks and adding commands.
|
|
All of the Harmony patching is done for you, so you can focus on writing your mod instead of reading swathes of undocumented code.
|
|
- *Stability* The API aims to be reliable and consistent between versions.
|
|
This means your code won't break when the GamecraftModdingAPI or Gamecraft updates.
|
|
|
|
For more info, please check out the [official documentation](https://mod.exmods.org).
|
|
|
|
For more support, join the ExMods [Discord](https://discord.exmods.org).
|
|
|
|
## Installation
|
|
[Please follow the official mod installation guide](https://www.exmods.org/guides/install.html) or use GCMM.
|
|
|
|
## Development
|
|
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.
|
|
This will allow your IDE to resolve references to Gamecraft files for building and IDE tools.
|
|
|
|
GamecraftModdingAPI version numbers follow the [Semantic Versioning guidelines](https://semver.org/).
|
|
|
|
## External Libraries
|
|
GamecraftModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to modify the behaviour of existing Gamecraft code.
|
|
|
|
# Disclaimer
|
|
This API is an unofficial modification of Gamecraft software, and is not endorsed or supported by FreeJam or Gamecraft.
|
|
The GamecraftModdingAPI developer(s) claim no rights on the Gamecraft code referenced within this project.
|
|
All code contained in this project is licensed under the [GNU Public License v3](https://git.exmods.org/modtainers/GamecraftModdingAPI/src/branch/master/LICENSE).
|
|
|