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

docs/Developers: horizons/odyssey flags now compulsory

Browse Source 
* Listeners really do need these, where defined in the schemas, so state
  that they're mandatory.
* REALLY emphasise that where an `Odyssey` flag isn't in `LoadGame` Senders
  MUST NOT send it with a `false` value.

  Although pending addition of header->gameversion will aid Listeners,
  currently this could give the misleading impression that a 3.8 Horizons
  client is a 4.0 Horizons client.
This commit is contained in:
Athanasius 2022-09-27 12:42:14 +01:00
parent a04d0e8d96
commit 69cc27fd63
No known key found for this signature in database
GPG Key ID: 8C392035DD80FD62
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Developers.md
View File

@ -251,10 +251,14 @@ so that you are aware of any changes to Schemas.
#### `horizons` and `odyssey` flags #### `horizons` and `odyssey` flags
Where the Schema allows for them, `horizons` and `odyssey` keys SHOULD be Where the Schema allows for them, `horizons` and `odyssey` keys **MUST** be
added with appropriate boolean values. `null` is not allowed in the values, added with appropriate boolean values. `null` is not allowed in the values,
so **if you cannot determine a value do not include that key at all**. so **if you cannot determine a value do not include that key at all**.
To emphasise that, *in the case where there is no `Odyssey` boolean in the
`LoadGame` event* **DO NOT INCLUDE IT IN THE EDDN MESSAGE**. No, not with a
`false` value. **DO NOT INCLUDE IT**.
The only source of these is the `LoadGame` event from journals. It's present The only source of these is the `LoadGame` event from journals. It's present
both in the PC local files and the CAPI journal data. If you're both in the PC local files and the CAPI journal data. If you're
composing a shipyard or outfitting message from CAPI data then it is composing a shipyard or outfitting message from CAPI data then it is