YAML Basics🔗

This plugin uses the YAML (.yml) format for all files. You may already know it from other plugins as most use this format.

Unfortunately, you'll likely soon experience that your quest is not working because you made a YAML syntax error. This is the case because it is quite easy to make a mistake in YAML syntax.

So let's briefly talk about what YAML is and how it works.

Requirements

No further requirements

Related Docs

Handling YAML Errors

What is YAML?🔗

YAML is a data-serialization language that is readable by humans. It is frequently used for Minecraft related configuration files.

YAML is key: "value" based. This means you use a to get a certain value. Values should be surrounded by double quotes ("..."). Let me show you an example:

YAML Data Format


key: "value"
Jack: "Some data about Jack"

Now you can use the Jack to obtain Some data about Jack.

Keys and values can also be nested into each other. Then they must be indented with two spaces.

Nested YAML


outerName:
  innerName: "innerValue"
  anotherInnerName: "BetonQuest is great!"

Tabs are not supported. Use spaces instead.

You shouldn't name anything yes, no, on, off, null, true or false as those names are reserved keywords in YAML.

Next Step: Conversations