mirror of
https://github.com/EDCD/EDDN.git
synced 2025-04-27 21:52:14 +03:00
3474fcc8da
It was 'correct' in the template, but that's a directory deeper. Some instances were still pointing at the wrong file.
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# EDDN NavBeaconScan Schema
|
|
|
|
## Introduction
|
|
Here we document how to take data from an ED `NavBeaconScan` 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.
|
|
|
|
If you find any discrepancies between what this document says and what is
|
|
defined in the relevant Schema file, then you should, in the first instance,
|
|
assume that it is the Schema file that is correct.
|
|
**PLEASE open
|
|
[an issue on GitHub](https://github.com/EDCD/EDDN/issues/new/choose)
|
|
to report any such anomalies you find so that we can check and resolve the
|
|
discrepancy.**
|
|
|
|
## Senders
|
|
The primary data source for this schema is the ED Journal event
|
|
`NavBeaconScan`.
|
|
|
|
### Augmentations
|
|
#### horizons and odyssey flags
|
|
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
|
|
in the Developers' documentation.
|
|
|
|
#### StarSystem
|
|
You MUST add a `StarSystem` key/value pair representing the name of the
|
|
system this event occurred in. Source this from either `Location`,
|
|
`FSDJump` or `CarrierJump` as appropriate.
|
|
|
|
#### StarPos
|
|
You MUST add a `StarPos` array containing the system co-ordinates from the
|
|
last `FSDJump`, `CarrierJump`, or `Location` event.
|