From a24fa98067764311c95dc548000411888936ff5c Mon Sep 17 00:00:00 2001 From: Jeremy Rimpo Date: Sat, 26 Apr 2025 00:28:49 -0500 Subject: [PATCH] Applying changes as per discussion --- schemas/scanorganic-README.md | 23 ++++++++++++++++------- schemas/scanorganic-v1.0.json | 10 +++++----- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/schemas/scanorganic-README.md b/schemas/scanorganic-README.md index 8909d3a..52aed50 100644 --- a/schemas/scanorganic-README.md +++ b/schemas/scanorganic-README.md @@ -57,9 +57,9 @@ last `FSDJump`, `CarrierJump`, or `Location` event. BodyID is already present in the form of the 'Body' key. This should be renamed to BodyID to mirror many other events. -You MUST track `BodyName` both from Status.json *and* also from some -Journal events in order to cross-check it before using the `Body` from -Journal events. +If proper synchronicity can be achieved, `BodyName` should be reported, +be it from Status.json or from some Journal events. Please cross-check it +as possible before using the `Body` from Journal events. The following is correct as of game version 4.0.0.801 (Odyssey initial release, Update 7, plus one patch). @@ -84,7 +84,16 @@ release, Update 7, plus one patch). 5. If Status.json does **not** have `BodyName` then clear `status_body_name`. #### Latitude / Longitude -While latitude and longitude are not reported with the event data, this event -necessitates being on a planet surface. Pulling the current coordinates from -the `Status.json` should be sufficient to populate the data. The `Status.json` -granularity is quite accurate when on-foot. +As live `Status.json` data is not always available, this augmentation is +optional. While latitude and longitude are not reported with the event data, +this event necessitates being on a planet surface. Pulling the current coordinates +from the `Status.json` should be sufficient to populate the data. Please ensure +the data is properly synced with the journal event. + +### Use of status.json +You are encouraged to augment your submission with values from status.json. When status.json is used: + +* You must verify that the timestamp from status.json is no more than one minute older than the timestamp from the `ScanOrganic` journal event +* You must verify that the status.json `Flags2` value `0x00000010` is true (indicating that the commander is on-foot on a planet) +* You must verify that the `BodyName` from status.json and journal events are in agreement +* Please augment your submission with `BodyName`, `Latitude`, and `Longitude` values diff --git a/schemas/scanorganic-v1.0.json b/schemas/scanorganic-v1.0.json index e0f6fbc..5183aae 100644 --- a/schemas/scanorganic-v1.0.json +++ b/schemas/scanorganic-v1.0.json @@ -33,7 +33,7 @@ "type" : "object", "description" : "Contains all properties from the listed events in the client's journal minus the Localised strings and the properties marked below as 'disallowed'", "additionalProperties" : false, - "required" : [ "timestamp", "event", "ScanType", "Genus", "Species", "Latitude", "Longitude", "SystemAddress", "BodyID", "BodyName"], + "required" : [ "timestamp", "event", "ScanType", "Genus", "Species", "SystemAddress", "BodyID"], "properties" : { "timestamp": { "type" : "string", @@ -74,7 +74,7 @@ "Variant": { "type" : "string", "minLength" : 1, - "description" : "Internal ID of bio variant string. This mirrors the CodexEntry name." + "description" : "Internal ID of bio variant string. This mirrors the CodexEntry name. Not present in older journal files." }, "SystemAddress": { "type" : "integer" @@ -89,15 +89,15 @@ }, "BodyName": { "type" : "string", - "description" : "Must be added by the sender to corroborate BodyID" + "description" : "Optional. Must be added by the sender, perhaps from Status.json." }, "Latitude": { "type" : "number", - "description" : "Must be added by the sender, generally from Status.json" + "description" : "Optional. Must be added by the sender, typically from Status.json." }, "Longitude": { "type" : "number", - "description" : "Must be added by the sender, generally from Status.json" + "description" : "Optional. Must be added by the sender, typically from Status.json." } }, "patternProperties": {