Applying changes as per discussion

This commit is contained in:
Jeremy Rimpo 2025-04-26 00:28:49 -05:00
parent a3724363c8
commit a24fa98067
No known key found for this signature in database
GPG Key ID: D72B900810CF2AD6
2 changed files with 21 additions and 12 deletions

View File

@ -57,9 +57,9 @@ last `FSDJump`, `CarrierJump`, or `Location` event.
BodyID is already present in the form of the 'Body' key. This should be BodyID is already present in the form of the 'Body' key. This should be
renamed to BodyID to mirror many other events. renamed to BodyID to mirror many other events.
You MUST track `BodyName` both from Status.json *and* also from some If proper synchronicity can be achieved, `BodyName` should be reported,
Journal events in order to cross-check it before using the `Body` from be it from Status.json or from some Journal events. Please cross-check it
Journal events. as possible before using the `Body` from Journal events.
The following is correct as of game version 4.0.0.801 (Odyssey initial The following is correct as of game version 4.0.0.801 (Odyssey initial
release, Update 7, plus one patch). 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`. 5. If Status.json does **not** have `BodyName` then clear `status_body_name`.
#### Latitude / Longitude #### Latitude / Longitude
While latitude and longitude are not reported with the event data, this event As live `Status.json` data is not always available, this augmentation is
necessitates being on a planet surface. Pulling the current coordinates from optional. While latitude and longitude are not reported with the event data,
the `Status.json` should be sufficient to populate the data. The `Status.json` this event necessitates being on a planet surface. Pulling the current coordinates
granularity is quite accurate when on-foot. 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

View File

@ -33,7 +33,7 @@
"type" : "object", "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'", "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, "additionalProperties" : false,
"required" : [ "timestamp", "event", "ScanType", "Genus", "Species", "Latitude", "Longitude", "SystemAddress", "BodyID", "BodyName"], "required" : [ "timestamp", "event", "ScanType", "Genus", "Species", "SystemAddress", "BodyID"],
"properties" : { "properties" : {
"timestamp": { "timestamp": {
"type" : "string", "type" : "string",
@ -74,7 +74,7 @@
"Variant": { "Variant": {
"type" : "string", "type" : "string",
"minLength" : 1, "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": { "SystemAddress": {
"type" : "integer" "type" : "integer"
@ -89,15 +89,15 @@
}, },
"BodyName": { "BodyName": {
"type" : "string", "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": { "Latitude": {
"type" : "number", "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": { "Longitude": {
"type" : "number", "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": { "patternProperties": {