third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-06-14 22:32:20 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas: navroute: README: Initial version

Browse Source
This commit is contained in:
Athanasius 2021-11-01 14:58:54 +00:00
parent 67e77136ff
commit 6c1d8cff92
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
schemas/navroute-README.md Normal file
View File

@ -0,0 +1,29 @@
# EDDN NavRoute Schema
## Introduction
Here we document how to take data from an ED `NavRoute` Journal
Event and properly structure it for sending to EDDN.
Please consult [EDDN Schemas README](./README-EDDN-schemas.md) for general
documentation for a schema such as this.
## Senders
The primary data source for this schema is the `NavRoute.json` file. That
it has been freshly written is signalled by the ED Journal event `NavRoute`.
So, monitor the Journal as normal, and when you see a `NavRoute` event open
the `NavRoute.json` file for reading, read it, and close it again. Use the
data you got from reading this file, not merely the Journal event.
The primary data to be sent is the `Route` array from the contents of the
separate file.
### Elisions
There are no elisions in this schema.
### Augmentations
#### horizons flag
You SHOULD add this key/value pair, using the value from the `LoadGame` event.
#### odyssey flag
You SHOULD add this key/value pair, using the value from the `LoadGame` event.