diff --git a/schemas/TEMPLATES/journalevent-README.md b/schemas/TEMPLATES/journalevent-README.md index f85fc86..890d782 100644 --- a/schemas/TEMPLATES/journalevent-README.md +++ b/schemas/TEMPLATES/journalevent-README.md @@ -106,10 +106,20 @@ value is what the name would have been in the source Journal data. Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags) in the Developers' documentation. +#### StarSystem +You MUST add a `StarSystem` string containing the name of the system from the +last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + ## Listeners The advice above for [Senders](#senders), combined with the actual Schema file *should* provide all the information you need to process these events. diff --git a/schemas/approachsettlement-README.md b/schemas/approachsettlement-README.md index 13bfcd7..93c8237 100644 --- a/schemas/approachsettlement-README.md +++ b/schemas/approachsettlement-README.md @@ -64,6 +64,12 @@ 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. +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** diff --git a/schemas/codexentry-README.md b/schemas/codexentry-README.md index 1c675d3..beb6555 100644 --- a/schemas/codexentry-README.md +++ b/schemas/codexentry-README.md @@ -27,6 +27,9 @@ in the Developers' documentation. You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + #### BodyID and BodyName You SHOULD attempt to track the BodyName and BodyID where the player is and add keys/values for these. diff --git a/schemas/fssallbodiesfound-README.md b/schemas/fssallbodiesfound-README.md index 350a318..e535b32 100644 --- a/schemas/fssallbodiesfound-README.md +++ b/schemas/fssallbodiesfound-README.md @@ -27,3 +27,6 @@ in the Developers' documentation. #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** diff --git a/schemas/fssdiscoveryscan-README.md b/schemas/fssdiscoveryscan-README.md index ba5a5eb..f7c8757 100644 --- a/schemas/fssdiscoveryscan-README.md +++ b/schemas/fssdiscoveryscan-README.md @@ -27,3 +27,6 @@ in the Developers' documentation. #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** diff --git a/schemas/journal-README.md b/schemas/journal-README.md index 5dd7cea..c2aa572 100644 --- a/schemas/journal-README.md +++ b/schemas/journal-README.md @@ -72,15 +72,20 @@ You SHOULD add this key/value pair, using the value from the `LoadGame` event. 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. +If not already present, you MUST add a `StarSystem` string containing the +name of the system from the last `FSDJump`, `CarrierJump`, or `Location` event. -#### SystemAddress -You MUST add a `SystemAddress` key/value pair representing the numerical ID -of the system this event occurred in. Source this from either `Location`, -`FSDJump` or `CarrierJump` as appropriate. +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + +This should only apply to `SAASignalsFound` events. #### StarPos -You MUST add a `StarPos` array containing the system co-ordinates from the -last `FSDJump`, `CarrierJump`, or `Location` event. +If not already present, you MUST add a `StarPos` array containing the +system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` +event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + +This should only apply to `Docked`, `Scan` and `SAASignalsFound` events. diff --git a/schemas/navbeaconscan-README.md b/schemas/navbeaconscan-README.md index 39167a2..09ecdef 100644 --- a/schemas/navbeaconscan-README.md +++ b/schemas/navbeaconscan-README.md @@ -29,6 +29,12 @@ 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. +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** + #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).** diff --git a/schemas/scanbarycentre-README.md b/schemas/scanbarycentre-README.md index d7b5f01..89c1ce6 100644 --- a/schemas/scanbarycentre-README.md +++ b/schemas/scanbarycentre-README.md @@ -30,3 +30,6 @@ in the Developers' documentation. #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. + +**You MUST apply a location cross-check, as per +[Other data augmentations](../docs/Developers.md#other-data-augmentations).**