Modding:Handbook Guide: Difference between revisions
Craluminum (talk | contribs) (Created page with "<!--T:1--> ""Handbook guides"" are separate pages in handbook dedicated to explain various game mechanics. === Adding new guide === <!--T:2--> 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:<syntaxhighlight lang="json"> { "pageCode": "morepies:introduction", "title": "morepies:introduction-title", "text": "morepies:introduction-text" }</...") |
Craluminum (talk | contribs) m (fix domains) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> | |||
__TOC__ | |||
<translate> | |||
<!--T:1--> | <!--T:1--> | ||
Handbook guides are separate pages in handbook dedicated to explain various game mechanics. | |||
=== Adding new guide === <!--T:2--> | === Adding new guide === <!--T:2--> | ||
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:<syntaxhighlight lang="json"> | New file should look inside like this:<syntaxhighlight lang="json"> | ||
Line 12: | Line 18: | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
Note that | 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: | |||
<syntaxhighlight lang="json"> | |||
"categoryCode": "morepies:category"</syntaxhighlight> | |||
Add two keys to localization file (for example, in "assets/morepies/lang/en.json"):<syntaxhighlight lang="json"> | |||
{ | |||
"introduction-title": "Pies 101", | |||
"introduction-text": "Pies are a very tasty food.", | |||
}</syntaxhighlight> | |||
And another two keys for category (if you added new):<syntaxhighlight lang="json"> | |||
{ | { | ||
" | "game:handbook-category-morepies": "More Pies", | ||
"morepies: | "handbook-category-morepies:category": "More Pies", | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
Now reload your world and you can find new guide in handbook | Now reload your world and you can find new guide in handbook | ||
</translate> | |||
{{Navbox/contentmodding}} |
Latest revision as of 14:39, 9 August 2024
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
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 |