This is the host repository for the TerraFirmaCraft API documentation. It is intended for pack makers and addon developers who want to get information on how TFC (official and unofficial) APIs work.
Note: this is not a wiki! If you are a player of TFC-TNG, you will not find in-game documentation here. This is for developers of addons and packs using TFC-TNG. For gameplay documentation, consult the wiki instead.
The Docsy-Jekyll Template is licensed under the Apache 2.0 License, and this is also released under the same license.
Installation instructions are for WSL (Windows Subsystem for Linux), as Jekyll can be finicky on Windows. These notes are adapted from the Jekyll installation instructions, and various sources of installation help.
- Install dependencies for ruby, and compiling the later gems.
sudo apt install make gcc g++
// This line was a fix noted from http://nokogiri.org/tutorials/installing_nokogiri.html
sudo apt-get install zlib1g-dev liblzma-dev patch- Install Ruby.
sudo apt install ruby-full- Install the
jekyllandbundlergems.
sudo gem install jekyll bundler- Install required dependencies.
sudo bundle install- Run jekyll to serve the wiki locally
bundle exec jekyll serve- Navigate to the server address to test. (
http://127.0.0.1:4000/Documentation/)
