Athanasius
723e966b37
docs/README schemas: Be explicit about sub-second timestamp resolution
2022-06-24 14:48:11 +01:00
Athanasius
5d945297e1
schemas/fsssignaldiscovered: timestamp required per signal
2022-06-15 12:42:53 +01:00
Athanasius
3dbfd18188
schemas/fsssignaldiscovered: Rework for per-signal timestamp & misc. clarifications
...
* Per-signal `timestamp` due to the nature of USS signals.
* Keeping `message`->`timestamp` so any Listener relying on it being there
isn't tripped up (it's present in all other schemas).
* Specifiy that each `signals` member should have `event` key/value pair
removed.
* Mandate removal of `SystemAddress` from each `signals` member.
* Receivers: Only `horizons` and `odyssey` augmentations are optional.
* Updated examples for these changes.
2022-06-15 11:52:25 +01:00
Athanasius
d33c752c36
schemas/fsssignaldiscovered: README: Remove timestamp/SystemAddress from each signal
2022-06-14 14:03:49 +01:00
Athanasius
86f56eaac2
schemas/fsssignaldiscovered README: Reworked for changed schema
...
* Purely event-based batching, no timer.
* Outline Horizons/Odyssey differences.
* Point out that USS are manually scanned, so different in time nature.
* StarSystem renamed from systemName.
* StarSystem and StarPos now mandatory.
2022-06-14 14:01:36 +01:00
Athanasius
329d59831f
schemas/fsssignaldiscovered: Rework based on in-game findings
...
1. Unix, not DOS, line-endings.
2. `message`->`timestamp` instead of per signal.
3. `message`->`SystemAddress` instead of per signal.
4. `StarSystem` and `StarPos` augmentations now mandatory.
2022-06-14 13:59:13 +01:00
732de9bdd6
FSSSignalDiscovered doc
2022-06-13 22:40:08 +03:00
fb9904306b
FSSSignalDiscovered doc: add examples
2022-06-13 22:40:08 +03:00
03caeaa20c
FSSSignalDiscovered: initial documentation
2022-06-13 22:40:05 +03:00
6dbc9e392a
FSSSignalDiscovered: don't pass $USS_Type_MissionTarget; USS_Type
2022-06-13 22:36:12 +03:00
5386ed2c64
FSSSignalDiscovered: add properties
2022-06-13 22:36:12 +03:00
036e918fe9
FSSSignalDiscovered: optional systemName and StarPos
2022-06-13 22:36:12 +03:00
912fa0e064
WIP: FSSSignalDiscovered event support
2022-06-13 22:35:58 +03:00
Athanasius
85031ba2b0
schemas/template: Update template for StarSystem default & cross-checks
...
* New schemas will need to use `StarSystem`, not `SystemName` or `System`, if
applicable, so have that example here.
* Any such augmentations need the cross-check mandating.
2022-05-31 13:21:49 +01:00
Athanasius
c3149f06bc
schemas/journal: Better word StarSystem and StarPos Augmentation docs
...
And also include the MUST about cross-checks.
2022-05-29 15:41:13 +01:00
Athanasius
bc628bff6f
schemas/journal: All relevant events already have SystemAddress
...
So there's no need to document it as an augmentation. This was an error
based on examining the EDMC code.
2022-05-29 15:37:44 +01:00
Athanasius
e78ecc4ae7
schemas/scanbarycentre: Senders MUST apply cross-check on augmentations
2022-05-29 15:07:36 +01:00
Athanasius
c47699f11a
schemas/navbeaconscan: Senders MUST apply cross-check on augmentations
2022-05-29 15:05:01 +01:00
Athanasius
209a02a3bb
schemas/fssdiscoveryscan: Senders MUST apply cross-check on StarPos augmentation
2022-05-29 15:03:17 +01:00
Athanasius
fbdd531372
schemas/fssallbodiesfound: Senders MUST apply cross-check on StarPos augmentation
2022-05-29 15:00:44 +01:00
Athanasius
509521dd83
schemas/codexentry: Senders MUST apply cross-check on StarPos augmentation
2022-05-29 14:57:54 +01:00
Athanasius
3b84e851b8
schemas/approachsettlement: Senders MUST apply cross-checks on augmentations
2022-05-29 14:48:42 +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
370cef676f
schemas/fssbodysignals: Use StarSystem not SystemName
...
This matches what's done in other schemas, and allows for use of common
code in EDMC.
2022-05-29 12:36:53 +00:00
Athanasius
8e5b17acdd
schemas/fssbodysignals: Augment also with SystemName (as per schema)
2022-05-29 11:18:53 +00:00
Gareth Harper
cda25f4882
added missing BodyName field
2022-05-25 15:46:13 +00:00
Gareth Harper
bece26156e
added fss body signals journal event
2022-05-25 14:39:55 +00:00
Athanasius
77a2d41d96
approachsettlement/1: Allow MarketID to be optional & document why
2022-02-19 11:29:19 +00:00
Athanasius
6ac735b1ac
schemas/navbeacon: Removing dangling comma
2022-01-31 10:31:07 +00:00
Athanasius
a1a20f511a
schemas/codexentry: Don't linkify 'Journal'
...
That section is gone/moved/renamed, and this is un-necessary anyway.
2022-01-30 17:38:38 +00:00
Athanasius
3474fcc8da
schemas/READMEs: Fix the 'horizons and odyssey' link
...
It was 'correct' in the template, but that's a directory deeper. Some
instances were still pointing at the wrong file.
2022-01-30 17:25:28 +00:00
Athanasius
a07e2ad86a
schemas/outfitting: Fix 'capi lag' link to new location
2022-01-30 17:16:30 +00:00
Athanasius
5492b4fb60
schemas/shipyard: Align with current standards
2022-01-30 17:14:59 +00:00
Athanasius
6b213795e5
schemas/scanbarycentre: Bring in line with current standards
2022-01-30 16:54:58 +00:00
Athanasius
ec781aa94f
schemas/misc READMEs: Remove extraneous 'over '
2022-01-30 16:40:28 +00:00
Athanasius
c903df1dd5
schemas/outfitting: Bring in line with current standards
2022-01-30 16:39:35 +00:00
Athanasius
cb849f3d9e
schemas/template: Minor grammar tweak to README
2022-01-30 16:38:43 +00:00
Athanasius
2969bb2eb1
schemas/navroute: Bring in line with current standards
2022-01-30 16:16:46 +00:00
Athanasius
adcf6b6010
schemas/navbeaconscan: Bring in line with current standards
2022-01-30 16:13:56 +00:00
Athanasius
c73b3d6e08
schemas: Align Introduction blurbs
2022-01-30 16:11:13 +00:00
Athanasius
2efa760009
schemas/fssdiscoveryscan: Bring in line with current standards
...
* Remove un-necessary README text.
* Remove un-necessary description on `SystemAddress` (it's always present).
2022-01-30 16:07:51 +00:00
Athanasius
2684d7bcf1
schemas/fssallbodiesfound: Bring in line with current standards
...
* Remove un-necessary README text.
* SystemAddress is always in the Journal events, so lose the misleading
description.
2022-01-30 16:04:26 +00:00
Athanasius
0ee415deb1
schemas/commodity: Bring in line with new standards
...
* There's a lot that's still only in the README, which I would have added when
creating the README based on EDMC code.
* Specific ellisions now marked in the schema.
* All key renames now marked in the schema.
2022-01-30 15:57:26 +00:00
Athanasius
8de80a868a
docs: More DRY and getting things in the correct places
2022-01-30 15:29:41 +00:00
Athanasius
93713ffa9b
schemas/codexentry: Re-align README with current standards
2022-01-30 15:16:46 +00:00
Athanasius
43152bbce8
schemas/blackmarket: Bring in line with newer documentation
2022-01-30 14:48:07 +00:00
Athanasius
500ce86d51
schemas/template: Define renamed usage
2022-01-30 14:40:46 +00:00
Athanasius
e6d0240c36
schemas/template: Define how to tag a key as having been renamed
2022-01-30 14:36:39 +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
c9d0e30e42
schemas/README: Flesh out this in its new 'stub' form
...
The remaining extant text has also now been moved into `docs/Developers.md`.
2022-01-30 12:55:33 +00:00
