ExMods/TechbloxModdingAPI
1
0
Fork 0
Code Issues Pull requests Projects Releases 25 Packages Wiki Activity
A stable modding interface between Techblox and mods
158 commits 4 branches 25 tags 901 KiB
C# 98.8%
Python 1.2%
Find a file
NGnius (Graham) 9e6edc19bd Implement SFX block API and bump version
2020-09-23 15:31:54 -04:00
Automation Merge branch 'master' into preview 2020-08-07 12:23:16 -04:00
docs Fix expired discord invite 2020-06-04 08:31:09 -04:00
GamecraftModdingAPI Implement SFX block API and bump version 2020-09-23 15:31:54 -04:00
.gitattributes Create dependency gen 2019-12-12 21:00:11 -08:00
.gitignore Improve doc layout & style 2020-01-29 17:02:51 -05:00
doxygen.conf Add wiring API and improve signal support 2020-08-03 12:45:38 -04:00
doxygen.xml Improve doc layout & style 2020-01-29 17:02:51 -05:00
GamecraftModdingAPI.sln Add automatic testing functionality 2020-06-17 21:04:40 -04:00
LICENSE Initial commit 2019-12-11 19:45:29 +00:00
README.md Improve dev info in README 2020-07-24 11:10:20 -04:00

README.md

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.

For more support, join the ExMods Discord.

Installation

Please follow the official mod installation guide 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.

External Libraries

GamecraftModdingAPI includes 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.