Modding:Handbook Guide

Handbook guides are separate pages in handbook dedicated to explain various game mechanics.

Adding new guide

In this case we will use morepies as mod domain and modid.

We create new file named 101-pies.json and then put it to "assets/morepies/config/handbook" folder.

New file should look inside like this:

{
    "pageCode": "morepies:introduction",
    "title": "morepies:introduction-title",
    "text": "morepies:introduction-text"
}

Note that pageCode should be unique, for example, morepies:introduction.

If you want your guide in specific category, then add following in the same file:

"categoryCode": "morepies:category"

Add two keys to localization file (for example, in "assets/morepies/lang/en.json"):

{
    "introduction-title": "Pies 101",
    "introduction-text": "Pies are a very tasty food.",
}

And another two keys for category (if you added new):

{
    "game:handbook-category-morepies": "More Pies",
    "handbook-category-morepies:category": "More Pies",
}

Now reload your world and you can find new guide in handbook

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.