This repository contains the API for the Chunk Stories project. The chunkstories project implements this API, and all mods (including the core content of the game) link against the API.
To learn more about Chunk Stories in general, please read the readme of the main repo.
This is for building chunkstories-api, the game's API. If you are only looking to write mods, you do not have to mess with this at all and should rather follow the mods creation guide on the project Wiki !
Nothing in particular to do. Gradle handles most dependencies for you.
Enklume is our homegrown Minecraft Anvil file format library. You'll need that too. Clone it, do gradlew install and you're good :)
./gradlew installbuilds the API and installs it to the local maven repository.
- To lean how to play the game and register an account, please visit http://chunkstories.xyz
- You can find a lot more information on the game wiki, including guides to writing mods, at http://chunkstories.xyz/wiki/
- You can find videos and dev logs on the lead developer Youtube channel: http://youtube.com/Hugobros3
- We have a discord where anyone can discuss with the devs: https://discord.gg/wudd4pe
- You can get support either by opening a issue on this project or by visiting the subreddit over at https://reddit.com/r/chunkstories
chunkstories-api's implementation is released under LGPL, see LICENSE.MD