third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-12 07:00:04 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas: Refer to Developers.md about gameversion/build.

Browse Source
This commit is contained in:
Athanasius 2022-09-27 16:20:59 +01:00
parent aa99d3e057
commit 6046c0a6d7
No known key found for this signature in database
GPG Key ID: 8C392035DD80FD62
15 changed files with 46 additions and 375 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
schemas/approachsettlement-README.md
View File

@ -58,33 +58,9 @@ Examples:
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarSystem

30
schemas/codexentry-README.md
View File

@ -23,33 +23,9 @@ The primary data source for this schema is the ED Journal event `CodexEntry`.
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarPos
You MUST add a `StarPos` array containing the system co-ordinates from the

30
schemas/commodity-README.md
View File

@ -60,33 +60,9 @@ Remove not only the `Category_Localised` key:values, but also the
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
### Using CAPI data
It is *not* recommended to use CAPI data as the source as it's fraught with

4
schemas/fcmaterials_capi-README.md
View File

@ -57,6 +57,10 @@ You **MUST NOT** set them otherwise, as e.g. the player could be active in
the game on another computer, using a different game mode and the CAPI data
will be for that game mode.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
## Listeners
The advice above for [Senders](#senders), combined with the actual Schema file
*should* provide all the information you need to process these events.

30
schemas/fcmaterials_journal-README.md
View File

@ -33,33 +33,9 @@ of any augmentations, as noted below.
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
## Listeners
The advice above for [Senders](#senders), combined with the actual Schema file

30
schemas/fssallbodiesfound-README.md
View File

@ -24,33 +24,9 @@ The primary data source for this schema is the ED Journal event
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarPos
You MUST add a `StarPos` array containing the system co-ordinates from the

30
schemas/fssbodysignals-README.md
View File

@ -24,33 +24,9 @@ The primary data source for this schema is the ED Journal event
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarSystem
You MUST add a `StarSystem` string containing the name of the system from the

30
schemas/fssdiscoveryscan-README.md
View File

@ -24,33 +24,9 @@ The primary data source for this schema is the ED Journal event
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarPos
You MUST add a `StarPos` array containing the system co-ordinates from the

30
schemas/fsssignaldiscovered-README.md
View File

@ -87,33 +87,9 @@ 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.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarSystem
You **MUST** add a `StarSystem` string containing the system name from the last

30
schemas/journal-README.md
View File

@ -65,33 +65,9 @@ The following keys+values should be removed from `Location` event data:
- `SquadronFaction` from within the list of `Factions`.
### Augmentations
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### horizons flag
You **MUST** add this key/value pair, using the value from the `LoadGame` event.

30
schemas/navbeaconscan-README.md
View File

@ -24,33 +24,9 @@ The primary data source for this schema is the ED Journal event
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarSystem
You MUST add a `StarSystem` key/value pair representing the name of the

29
schemas/navroute-README.md
View File

@ -31,30 +31,7 @@ separate file.
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.

29
schemas/outfitting-README.md
View File

@ -54,30 +54,7 @@ station. Namely:
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.

30
schemas/scanbarycentre-README.md
View File

@ -27,33 +27,9 @@ senders SHOULD include any defined in the schema if it's in the source data.
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
in the Developers' documentation.
#### gameversion
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
#### StarPos
You MUST add a `StarPos` array containing the system co-ordinates from the

29
schemas/shipyard-README.md
View File

@ -41,30 +41,7 @@ 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.
#### gameversion
You **MUST** always add this field **to the header object**.
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
1. If you are using Journal files directly then you **MUST** use the value
of the `gameversion` element from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
use its value.
3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but
with the value `"CAPI"`.
#### gamebuild
You **MUST** always add this field **to the header object**.
1. If you are using Journal files directly then you **MUST** use the value
of the `build` value from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process
Journal events then:
1. You will not have `Fileheader` available.
2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
its value.
3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
with the value `"CAPI"`.