Modding:Handbook Guide
Handbook guides are separate pages in handbook dedicated to explain various game mechanics.
Adding new guide
Create new file with unique name, for example, 101-pies.json, then put it to "assets/game/config/handbook" folder in your mod.
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/<mymod>/lang/en.json"):
{
"morepies:introduction-title": "Pies 101",
"morepies: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
Content Modding | |||||||||
---|---|---|---|---|---|---|---|---|---|
Basics | Content Mods • Developing a Content Mod • Packaging & Release | ||||||||
Tutorials |
|
||||||||
Concepts | Modding Concepts • Modinfo • Variants • Domains • Patching • Remapping • World Properties | ||||||||
Moddable Assets |
|
||||||||
Uncategorized |
|
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.
Modding | |
---|---|
Modding Introduction | Getting Started • Theme Pack |
Content Modding | Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts |
Code Modding | Code Mods • Setting up your Development Environment |
Property Overview | Item • Entity • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • World properties |
Workflows & Infrastructure | Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine |
Additional Resources | Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters Example Mods • API Docs • GitHub Repository |