24 Commits

Author SHA1 Message Date
Athanasius
feed1c27ec
docs/Developers: Fix 'For emphasis' emphasis (markdown) 2022-12-01 13:15:16 +00:00
Athanasius
ecf54c62eb
docs/Developers: Don't split "gamebuild may be empty". 2022-12-01 13:14:03 +00:00
Athanasius
e39fd25e7b
docs/Developers: gamebuild should not be whitespace-trimmed. 2022-12-01 11:36:36 +00:00
Athanasius
cebf3e5ea6
docs/Developers: CAPI-sourced data must denote which galaxy it is for 2022-12-01 11:26:01 +00:00
Athanasius
b00b3737d2
docs/Developers: Don't make it look like advice is about gamebuild
* The ordered-list advice is for `gameversion`, not `gamebuild`.  So move
  the latter mention below that list.
* Also mention `fcmaterials_capi` comes from `market` endpoint.
2022-11-25 15:39:11 +00:00
Athanasius
c54f452bf7
docs/Developers: Compression needs Content-Encoding header
... not `Content-Type`.
2022-10-31 08:52:14 +00:00
Athanasius
1df1032886
docs/Developers: Allow for "" gameversion/build values.
The emphasis here is on strongly encouraging Senders to get the actual, full
and correct, values to Listeners.  But where they can't, be that due to
data source limitations (CAPI), or their code architecture (common EDDN
sending code that has no concept of the data source), they're allowed to
send a less than optimal value.

**BUT**, they still should start sending the fields as outlined.
2022-09-29 14:58:35 +01:00
Athanasius
aa99d3e057
docs/Developers: Use CAPI-<endpoint> for gameversion/build
It's the true source of the data, and less fraught with corner cases than
trying to be sure that the Journal-derived values would be correct.
2022-09-27 16:05:49 +01:00
Athanasius
d57ab05ee3
docs/Developers: Define header component field:values
* Actually define what we expect from the existing fields.
* Document what should go in the new `gameversion` and `gamebuild` fields.
* Update the generic example to include all of these "what version of the game,
  or feature set, did this come from?" fields.
2022-09-27 15:50:17 +01:00
Athanasius
a723fbd83b
docs/Developers: Fix 'i3' vim-induced typo 2022-09-27 14:50:05 +01:00
Athanasius
69cc27fd63
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.
2022-09-27 12:42:14 +01:00
Athanasius
a04d0e8d96
docs/Developers: Update Fileheader/LoadGame for latest clients
This includes the new `4.0 Horizons` client, which changes the semantics
of what the `Odyssey` flag in the `Fileheader` means.  It now indicates if
the client is a 4.0+ one, not if the player is utilising Odyssey DLC.
2022-09-27 12:40:28 +01:00
Athanasius
ff83ede948
Gateway: Remove all form-encoded support
This causes issues, at the least, with compressed messages that 'look' like
they decompressed body is form-encoded.  18385 messages in the last month
rejected due to this.

No actually valid form-encoded messages in that time frame.
2022-06-16 13:27:11 +01:00
Athanasius
9a8ca522e6
docs/Developers: Fix two minor typos 2022-06-13 10:33:13 +01:00
Athanasius
d10b081be4
docs: Outline rules and caveats about data Augmentations
* Many will need a location cross-check.
* Call out this need in the fssbodysignals README.
2022-05-29 14:17:30 +01:00
Athanasius
70a04a4f77
docs/Developers: Call out that Listeners need to pay attention to Augmentations 2022-05-29 12:05:05 +01:00
Athanasius
88cabbf032
docs/Developers: Simplify link to 'Running-this-software.md' 2022-01-30 17:50:49 +00:00
Athanasius
8de80a868a
docs: More DRY and getting things in the correct places 2022-01-30 15:29:41 +00:00
Athanasius
3b8845d31a
docs: Resolving where "general message contents" lives and its format
* Most of it is once more in schemas/README.
* But keeping the horizons/odyssey flags in docs/Developers.md, as that's
  more about how you handle them in code.
2022-01-30 14:14:59 +00:00
Athanasius
692c28bd75
docs/Developers: Be *very* explicit about the live upload URL 2022-01-30 14:03:16 +00:00
Athanasius
10c43e5304
docs/Developers: Use relative schemas/ link & tweak horizons/odyssey flags reference 2022-01-30 13:07:38 +00:00
Athanasius
ead10a2c1e
docs/Developers: Tweak to why EDMC uses CAPI 2022-01-30 12:59:35 +00:00
Athanasius
de4900ac67
docs/Developers: Import remaining portion of old schemas/README 2022-01-30 12:57:44 +00:00
Athanasius
3e69b7b630
docs: Move most of schemas/README into docs/Developers.md 2022-01-30 12:46:20 +00:00