Libraries

Getting started

Table of contents

• Writing libraries
  • Examples
  • Optional attributes

Writing libraries

Libraries must start with the Library identifier to determine its type, followed by a string literal for the library name (this must not contain spaces, as it will be used as the class name).

Your code should be written in C#, within the limitations of .NET Standard 2.0.

Libraries should be written as APIs for code developers to use to easily access native game data or code.

Examples

Library "ExampleLibrary"
{
    // Write your code here.
}

Optional attributes

• by - used to give attribution to authors in case they should be contacted with reports.

  Example

  Library "ExampleLibrary" by "Hyper"
  

• does - used by the documentation generation tool for the description of the library.

  Single Line Example

  Library "ExampleLibrary" by "Hyper" does "A library to show examples with."
  

  Multiple Line Example

  Library "ExampleLibrary" by "Hyper" does
  /*
  A library to show examples with, but also with multiple lines.
  */