PyrML tutorial

Aug 6, 2017
PyrML tutorial
  • Hello ! This page explain you how to use PyrML.

    PyrML is an acronym for PYRRH4's Markup Language, I just needed a name. If you're here, that's probably because you're using a plugin that PYRRH4 made, and you have a file ending with .pyrml. PyrML is pretty similar to YML, but there are some changes.

    Tip : open a .pyrml file with Notepad++, and use Language > Makefile, so you have nice colors !

    Basics

    • When a line starts by #, it's a comment. Blank lines (with spaces or tabulation) or lines with comments will be ignored and won't affect the configuration.
    • The subsections are like classic key/value, without the value, and for each subsection, it's two more space before.
    • For each line attached to a subsection, it's below the section name and it starts by two spaces.
    • The character = separates keys and values. You can also use = : > ~ , ; and even use different ones for each lines.

    Strings and simple values

    Numbers looks like this :
    Code (Text):
    key=10
    Code (Text):
    key=18.5
    Booleans like this :
    Code (Text):
    key=true
    And strings looks like this, without "" or '' (and you don't need to escape the "" or '')
    Code (Text):
    key=This is a string, cool, isn't it ?
    Lists

    Lists looks like simple values, but with / and on multiple lines :
    Code (Text):
    key=/
      This is the list lines. First line,
      Second line,
      Third line,
      and so on
    You can add empty lists with / as well :
    Code (Text):
    key=/
    Example

    Here is a quick comparison of the same YAML and PYRML file :

    [​IMG]

    That's it !

    And if you're using Notepad++ or another similar software, use the colors from language "Makefile", which is pretty good.
  • Loading...
  • Loading...