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
Athanasius
3e69b7b630
docs: Move most of schemas/README into docs/Developers.md
2022-01-30 12:46:20 +00:00
Athanasius
396a2f0b3a
docs/schemas: Improve "what must be present or removed"
2022-01-30 12:38:32 +00:00
Athanasius
7337f83061
schemas/README: Tweak order and text of 'minimum message'
2022-01-29 17:26:25 +00:00
Athanasius
da109f85e7
schemas/README: State that schema files trump their README
2022-01-29 17:24:21 +00:00
Athanasius
d802448e4c
README: Linkify 'a defined format' & simplify plaintext/compression header
2022-01-29 17:18:43 +00:00
Athanasius
64dd5832d4
schemas: Journal event template: Couple StarPos instructions
2022-01-29 16:56:08 +00:00
Athanasius
5f5d0afb29
schemas/templates: Minor formatting/grammer cleanups
2022-01-29 16:53:42 +00:00
Athanasius
fa869c6478
schemas: Update horizons/odyssey descriptins in schema template
2022-01-29 16:47:58 +00:00
Athanasius
5fe2642d03
schemas: First cut of newjournalevent-README.md template
2022-01-29 16:45:11 +00:00
Athanasius
099eb72e73
schemas/README: Update horizons/odyssey flag section
...
* Re-confirmed what is in the `LoadGame` event for all 3 possible circumstances.
* Emphasised that the `Fileheader`->`Odyssey` value is different in nature.
2022-01-29 16:29:17 +00:00
Athanasius
eac3e1af4b
schemas: Add a 'new journal event schema' template
...
Hopefully the "not actually valid in JSON" comments make it obvious both what needs
to be edited, and that they all need removing.
2022-01-29 15:47:17 +00:00
Athanasius
989b997d15
schemas: Skeleton journal event template
2022-01-28 18:34:00 +00:00
Athanasius
6eb81e4461
schemas/README: Make some lists actual numbered lists
...
This is to aid with e.g. "point 2 in "Contents of message" when referring to
this documentation.
2022-01-28 18:16:17 +00:00
