Skip to content

Guidelines

You need to follow these rules in order to contribute to the docs. They are important for a good user experience and provide a consistent baseline for other contributors to work with.

Line length🔗

All lines must be wrapped after 121 character. You can exceed this limit by a few characters where reasonable. Tables and other special syntax are exempt from this rule.

Links can be created using Markdown's link syntax:

1
Click the [highlighted words](Contributing.md).
Result: Click the highlighted words.

Displaying (YAML) code🔗

You must use code boxes with the specific language set in the header (YAML in this example). You also have to enable line numbers by adding the linenums="1" argument. Sometimes a setting a title using title="Some Title" is also useful.

Example code
1
2
3
 ``` YAML linenums="1" title="Codebox"
 use: "codeboxes for code"
 ```

Result:

Codebox
1
use: "codeboxes for code"

Referring to YAML elements in written text🔗

An example of this would be to reference an event name in an explanation.

1
The event `someEvent` prints a message to the player!

Result: The event someEvent prints a message to the player!

File names🔗

Replace all spaces in file and folder names with -!

Referring to File Names in written text🔗

File names in written text must be quoted and italic.

Example: Open "events.yml" to add these new events.

Markdown Formatting Conventions🔗

Unfortunately, there are different ways to format text in Markdown. Please use the syntax outlined here:

Bold🔗

Bold text is surrounded by two asterisks on each side: **Bold text**

Italic🔗

Italic text is surrounded by one underscore on each side: _Italic text_

Lists🔗

Lists must be declared as such:

* Top Level
    - Second Level
    - Second Level
* Another Top level

Result:

  • Top Level
    • Second Level
    • Second Level
  • Another Top level