Skip to content

RSML Language Standards

Tip

Before proceeding, ensure you understand:

Since anyone can create their own RSML language standard, documenting standards is crucial for interoperability and maintenance.

Specifying which standard is in use

While optional, declaring your standard helps ensure consistent interpretation. That can be done by adding a comment to your RSML file, as shown below.

Note
  • The declaration is purely informational - it doesn't affect parsing.
  • Custom parsers may use this hint to apply correct interpretation rules.
  • Case-sensitive (official-25 ≠ Official-25).
# !standard: <standard-name> (1)
  1. Must be the first line of the file.
1
2
3
4
# !standard: official-25
win.+ -> "Primary operator"
linux.+ || "Secondary operator"
osx.+ ^! "Tertiary operator"

1
2
3
4
# !standard: roadlike
win.+ ??? "Primary operator"
linux.+ << "Secondary operator"
osx.+ !!! "Tertiary operator"

Documenting your standards

It's impossible for us to document every single standard, but we try to keep the most important ones here.

If you'd like to document your standard, you can follow this simple guide:

  1. Fork the rsml-docs repository.
  2. Copy this file into /docs/language/standards/.
  3. Give it the name of your standard (if your standard is mystand, you'd name it mystand.md).
  4. Edit the file with the details of your standard.
  5. Make a pull request.
  6. After reviewing, it'll either be accepted (you can then delete your fork) or rejected, in which case you can either make changes to it and try again or... not.
Tip

As long as you just follow the template and only edit what's relevant, your PR should be accepted.

If your standard is relevant enough, we'll do our best to add it here. However, we'd still appreciate the Pull Request.