From 69cc27fd638aeb1429c707b9d94a310e784eec1a Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 27 Sep 2022 12:42:14 +0100 Subject: [PATCH] docs/Developers: horizons/odyssey flags now compulsory * 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. --- docs/Developers.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/Developers.md b/docs/Developers.md index 191641c..b77499e 100644 --- a/docs/Developers.md +++ b/docs/Developers.md @@ -251,10 +251,14 @@ so that you are aware of any changes to Schemas. #### `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, 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 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