routes.ndjson format

This WIKI page describes the routes file format used by ISMU.

Route record

{"id": 5, "r": "21"}
{"id": 0, "r": "0", "nlt": true, "note": "Depot"}
{"id": 18, "r": "1", "note": "South city"}

Field	Type	Required	Description
id	int	yes	Unique route ID (sequential)
r	string	yes	Route number shown on display
nlt	bool	no (default: false)	No line telegram — skip DS001/DS001neu (line number) IBIS telegram for this route
note	string	no	Free-text operator note. Use to distinguish routes that share the same r value (e.g. two variants of route "1")

---

Direction record

Defines one direction (trip variant) of a route. Multiple direction records share the same did value - all belong to the route whose id equals that did.

{"did": 6, "p": 1041, "f": ["Marseille Street", "Shevchenko Street"], "s": ["Marseille st.", "Shevchenko st."]}
{"did": 6, "p": 1042, "f": ["Shevchenko Street", "Marseille Street"], "s": ["Shevchenko st.", "Marseille st."]}

Field	Type	Required	Description
did	int	yes	Route ID this direction belongs to (must match an existing id)
p	int	yes	Point ID - unique across the whole file;
f	list[str]	yes	Full destination names. One element for single-terminus directions (["Destination"]), two elements for two-terminus directions (["Start", "End"])
s	list[str]	no	Short destination names - same structure as f; used when force_short_names is enabled in config.json

Important

p values must be unique across all direction records in the file.

---

File structure example

{"id": 0, "r": "0", "nlt": true, "note": "Depot"}
{"did": 0, "p": 1, "f": ["Depot"]}
{"id": 5, "r": "21"}
{"did": 5, "p": 201, "f": ["Circular"]}
{"id": 6, "r": "104"}
{"did": 6, "p": 1041, "f": ["Marseille Street", "Shevchenko Street"], "s": ["Marseille st.", "Shevchenko st."]}
{"did": 6, "p": 1042, "f": ["Shevchenko Street", "Marseille Street"], "s": ["Shevchenko st.", "Marseille st."]}

Route records should appear before their direction records. Direction records for the same route may be placed anywhere after their route record, but grouping them together is recommended for readability.