Changes

no edit summary
Line 46: Line 46:  
| <code>signal_position</code> || ☑️ || recommended signal position for the signal position setting in RailOS for this simulation, either "left" or "right" side of the track.
 
| <code>signal_position</code> || ☑️ || recommended signal position for the signal position setting in RailOS for this simulation, either "left" or "right" side of the track.
 
|}
 
|}
 +
 +
=== Example ===
 +
 +
The following example is taken from the [[Glasgow Suburban]] project:
 +
 +
<pre>
 +
rly_file = "Glasgow_Suburban.rly"
 +
 +
ttb_files = [ "Glasgow_Suburban_2022_MoFri_5am.ttb",]
 +
 +
ssn_files = [ "Glasgow_Suburban_2022_MoFri_5am.ssn",]
 +
 +
graphic_files = []
 +
 +
img_files = [ "GlasgowSuburban.bmp",]
 +
 +
doc_files = [ "README.md",]
 +
 +
release_date = "2022-02-22"
 +
 +
version = "1.0.1"
 +
 +
country_code = "GB"
 +
 +
description = "A simulation of the suburban rail network around the Scottish city of Glasgow, UK"
 +
 +
display_name = "Glasgow Suburban"
 +
 +
name = "Glasgow Suburban"
 +
 +
year = 2022
 +
 +
author = "Krizar"
 +
 +
contributors = []
 +
 +
factual = true
 +
</pre>
    
=== Conventions ===
 
=== Conventions ===
* In order to be accessible across most systems Documentation is assumed to be either in markdown, plain text or a PDF. Using formatted file types like <code>.docx</code> adds difficulty for any Linux users.
+
* Metadata files are assumed to be in <code>.toml</code> format.
 
* Definition of <code>difficulty</code> is still under discussion as there is no clear metric to measure it yet, it is recommended this key be ignored for now.
 
* Definition of <code>difficulty</code> is still under discussion as there is no clear metric to measure it yet, it is recommended this key be ignored for now.
 
* Documentation is listed as mandatory as all simulations should be accompanied with some form of manual to help users.
 
* Documentation is listed as mandatory as all simulations should be accompanied with some form of manual to help users.
confirmed, superuser, Administrators
1,577

edits