diff --git a/schemas/navbeaconscan-README.md b/schemas/navbeaconscan-README.md new file mode 100644 index 0000000..c12e91b --- /dev/null +++ b/schemas/navbeaconscan-README.md @@ -0,0 +1,31 @@ +# 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. + +## Senders +The primary data source for this schema is the ED Journal event +`NavBeaconScan`. + +### 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. + +#### 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.