From 3b84e851b8c8f3e8eea700e9fb4b3769c48d3580 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 14:48:42 +0100 Subject: [PATCH 1/9] schemas/approachsettlement: Senders MUST apply cross-checks on augmentations --- schemas/approachsettlement-README.md | 6 ++++++ 1 file changed, 6 insertions(+) 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).** From 509521dd8398364b7df3bee1012a05353e1468c9 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 14:57:54 +0100 Subject: [PATCH 2/9] schemas/codexentry: Senders MUST apply cross-check on StarPos augmentation --- schemas/codexentry-README.md | 3 +++ 1 file changed, 3 insertions(+) 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. From fbdd531372c62f62cccb8403faa1fe5a6ea36449 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:00:44 +0100 Subject: [PATCH 3/9] schemas/fssallbodiesfound: Senders MUST apply cross-check on StarPos augmentation --- schemas/fssallbodiesfound-README.md | 3 +++ 1 file changed, 3 insertions(+) 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).** From 209a02a3bbf34e557338442c60f1f9413b9f5227 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:03:17 +0100 Subject: [PATCH 4/9] schemas/fssdiscoveryscan: Senders MUST apply cross-check on StarPos augmentation --- schemas/fssdiscoveryscan-README.md | 3 +++ 1 file changed, 3 insertions(+) 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).** From c47699f11a2e9aaca2be6f0c59136a10b559d226 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:05:01 +0100 Subject: [PATCH 5/9] schemas/navbeaconscan: Senders MUST apply cross-check on augmentations --- schemas/navbeaconscan-README.md | 6 ++++++ 1 file changed, 6 insertions(+) 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).** From e78ecc4ae70474dee8ed11bab68409db37bf2bb9 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:07:36 +0100 Subject: [PATCH 6/9] schemas/scanbarycentre: Senders MUST apply cross-check on augmentations --- schemas/scanbarycentre-README.md | 3 +++ 1 file changed, 3 insertions(+) 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).** From bc628bff6f2e92cda3df7af29a75b30cfb69fd8b Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:37:44 +0100 Subject: [PATCH 7/9] schemas/journal: All relevant events already have SystemAddress So there's no need to document it as an augmentation. This was an error based on examining the EDMC code. --- schemas/journal-README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/schemas/journal-README.md b/schemas/journal-README.md index 5dd7cea..5553afe 100644 --- a/schemas/journal-README.md +++ b/schemas/journal-README.md @@ -76,11 +76,6 @@ 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. -#### 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. - #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. From c3149f06bc054a5605c74afe9d540a57d01f2fd2 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 15:41:13 +0100 Subject: [PATCH 8/9] schemas/journal: Better word StarSystem and StarPos Augmentation docs And also include the MUST about cross-checks. --- schemas/journal-README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/schemas/journal-README.md b/schemas/journal-README.md index 5553afe..c2aa572 100644 --- a/schemas/journal-README.md +++ b/schemas/journal-README.md @@ -72,10 +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. + +**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. From 85031ba2b01b058545be5d35b15fedeb462624be Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 31 May 2022 13:21:49 +0100 Subject: [PATCH 9/9] schemas/template: Update template for `StarSystem` default & cross-checks * New schemas will need to use `StarSystem`, not `SystemName` or `System`, if applicable, so have that example here. * Any such augmentations need the cross-check mandating. --- schemas/TEMPLATES/journalevent-README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) 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.