|
12345678910111213141516171819202122232425262728293031 |
- # TechbloxModdingAPI
-
- Unofficial Techblox modding API for interfacing Techblox from mods.
-
- The TechbloxModdingAPI 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 TechbloxModdingAPI or Techblox 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 Techblox install folder.
- This will allow your IDE to resolve references to Techblox files for building and IDE tools.
-
- TechbloxModdingAPI version numbers follow the [Semantic Versioning guidelines](https://semver.org/).
-
- ## External Libraries
- TechbloxModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to modify the behaviour of existing Techblox code.
-
- # Disclaimer
- This API is an unofficial modification of Techblox software, and is not endorsed or supported by FreeJam or Techblox.
- The TechbloxModdingAPI developer(s) claim no rights on the Techblox code referenced within this project.
- All code contained in this project is licensed under the [GNU Public License v3](https://git.exmods.org/modtainers/TechbloxModdingAPI/src/branch/master/LICENSE).
-
|