Documentation index file | Iwakura Enterprises Docs

What is it?

The documentation index file is used by Voile to create new documentation entries within its interface. It contains various information and holds all topics. Based on the documentation type, Voile looks for it in specific places.

Server wiki: mods/IwakuraEnterprises_Voile/documentation/index.json
Mod wiki: src/main/resources/Common/Docs/{YourModGroup}_{YourModName}.json

Format

The documentation index file follows strict JSON format.

Full JSON example

{
  "documentations": [
    {
      "group": "MyGroup",
      "id": "MyExtensiveDocumentation",
      "name": "My extensive wiki",
      "enabled": true,
      "sortIndex": 1100,
      "compatibility": {
        "mod": {
          "universalDocumentationLoader": true
        }
      }
    },
    {
      "group": "MyGroup",
      "id": "MyDocumentation",
      "name": "My lovely wiki"
    }
  ]
}

DocumentationConfig object

Field	Type	Description
`group`	String	Mandatory Documentation's group
`id`	String	Mandatory Documentation's ID
`name`	String	Mandatory Documentation's name (shown in the UI)
`enabled`	Boolean	Whether the documentation should be shown in the UI
`sortIndex`	Integer	Sorting index for the documentation. Lower values are sorted first.
`compatibility`	`Compatibility`	Various compatibility options
`requiredPermissions`	List of `String`	List of required permissions for the player to all have to see the documentation.
`topics`	List of `TopicEntry`	Deprecated and available only for mod documentation index files.

Mod object

Field	Type	Description
`universalDocumentationLoader`	Boolean	Whether the `UniversalDocumentationLoader` can be used to load mod's topics. If disabled, uses old `ResourceDocumentationLoader` that reads only specified topics.

TopicEntry object

Field	Type	Description
`file`	String	File path to the topic file starting from the documentation root directory.
`subTopics`	List of `TopicEntry`	Recursive reference to other topic objects.

Documentation loaders

Voile has various documentation loaders that load different types of documentations.

`UniversalDocumentationLoader`

Used when loading server documentation and mod documentation that enables the universalDocumentationLoader compatibility. Supports all features Voile provides (topic localization, relative image paths, etc.)

Server documentations are loaded from mods/IwakuraEnterprises_Voile/documentation/index.json
Mod documentations are loaded from src/main/resources/Common/Docs/{YourModGroup}_{YourModName}.json

`ResourceMarkdownFileDocumentationLoader`

Used when loading one-file mod integration Markdown files. The Markdown files are loaded from src/main/resources/Common/Docs/{YourModGroup}_{YourModName}.md

`DirectDocumentationLoader`

Programmatically provides documentations. Only accessible to programmatic integrations using the VoileAPI.

`FileSystemDocumentationLoader`

Used to load server documentations from mods/IwakuraEnterprises_Voile/documentation directory.

`ResourcesDocumentationLoader`

Used to load mod documentations from the src/main/resources/Common/Docs/{YourModGroup}_{YourModName}.json directory. These documentations must specify the topic files manually, as there is no topic discovery.

`HMWikiDocumentationLoader`

Loads wiki pages from Hytale Modding Wiki as Voile documentations. Currently, it does not support topic localization and may occasionally display content incorrectly.