Mod Integration tutorial

Step 1 - Creating a documentation

1. Navigate to your mod's resources and create a Common folder.

2. Inside the Common folder, create a Docs folder.

3. Inside the Docs folder, create a new JSON file named {YourModGroup}_{YourModName}.json

This will create a new mod wiki under the group YourModGroup, with documentation ID MyDocumentation and with the name My Mod Name.

4. Create new folder named {YourModGroup}_MyDocumentation next to the {YourModGroup}_{YourModName}.json file.

The folder structure should look something like this:

Step 2 - Creating a topic

1. Inside the {YourModGroup}_MyDocumentation folder, create a new Markdown file named my-topic.md

This will create a new topic within the documentation. The text file contains information about the topic and the topic's Markdown content.

Step 3 - Creating a sub-topic

1. Inside the {YourModGroup}_MyDocumentation folder, create a new Markdown file named features.md

2. Open the my-topic.md file and add the sub-topics field inside the front-matter:

This will add the Features topic as a sub-topic for the My topic topic. Inside the sub-topics list you specify either a topic ID (usually based on the topic's file name) or a folder name (to include all topics inside the folder).

Step 4 - Localizing a topic

To translate a topic, create a new text file next to the topic you want to localize. Let's translate the My topic topic.

1. Create a new text file named my-topic$cs.md next to the my-topic.md file.

This will create localized topic for topic ID my-topic with the language code cs.

For players with their preferred language set to Czech, this translated topic will be shown.

Result

Further reading

To learn more, please see the following topics.

• Documentation index file

• Topic file

• Topic Identifiers

• Topic localization

• Markdown syntax

• Configuration

• User Interface