In [[Railway Operation Simulator]] (RailOS) ''Metadata'' files are files included within a simulation as a means of providing further information and properties not retrievable from the railway and timetable files. Inclusion of such a file was first proposed in 2021 by the ROS Development Team as an optional extension for projects and the decision made to use [https://toml.io/en/ TOML] as the syntax being both easily human and machine readable. The file is not strictly required but recommended, a starting version of this file is automatically generated via GitHub Actions when using the [https://github.com/Railway-Op-Sim/UN-Template Template Repository] provided by the [[Developer_GitHub_Organisation|Railway-Op-Sim GitHub Organisation]]. During installation of a simulation Metadata files should be placed within the <code>Metadata</code> directory in the <code>Railway</code> directory of the user's RailOS installation.
+
In [[Railway Operation Simulator]] (RailOS) ''Metadata'' files are files included within a simulation as a means of providing further information and properties not retrievable from the railway and timetable files. Inclusion of such a file was first proposed in 2021 by the RailOS Development Team as an optional extension for projects and the decision made to use [https://toml.io/en/ TOML] as the syntax being both easily human and machine readable. The file is not strictly required but recommended, a starting version of this file is automatically generated via GitHub Actions when using the [https://github.com/Railway-Op-Sim/UN-Template Template Repository] provided by the [[Developer_GitHub_Organisation|Railway-Op-Sim GitHub Organisation]]. During installation of a simulation Metadata files should be placed within the <code>Metadata</code> directory in the <code>Railway</code> directory of the user's RailOS installation.
== Schema ==
== Schema ==
Line 20:
Line 20:
| <code>ssn_files</code>|| ☑️ || list of session <code>.ssn</code> files
| <code>ssn_files</code>|| ☑️ || list of session <code>.ssn</code> files
|-
|-
−
| <code>doc_files</code>|| || list of documentation files (</code>.md</code>, </code>.txt</code>, </code>.pdf</code>)
+
| <code>doc_files</code>|| || list of documentation files (.md, .txt, .pdf)
|-
|-
| <code>img_files</code> || ☑️ || list of image files (see conventions)
| <code>img_files</code> || ☑️ || list of image files (see conventions)