mirror of
https://github.com/EDCD/EDDN.git
synced 2025-05-04 09:01:03 +03:00
92 lines
2.8 KiB
Markdown
92 lines
2.8 KiB
Markdown
# EDDN Journal Schema
|
|
|
|
## Introduction
|
|
Here we document how to take data from miscellaneous ED Journal
|
|
events and properly structure it for sending to EDDN.
|
|
|
|
This is the historical "all Journal events" schema that will be deprecated
|
|
in the future. Please check for a schema specific to the journal event
|
|
under consideration to see if data should be sent on that event specific
|
|
schema instead.
|
|
|
|
Please consult [EDDN Schemas README](./README-EDDN-schemas.md) for general
|
|
documentation for a schema such as this.
|
|
|
|
## Senders
|
|
The primary data source for this schema is the ED Journal events:
|
|
|
|
- `Docked`
|
|
- `FSDJump`
|
|
- `Scan`
|
|
- `Location`
|
|
- `SAASignalsFound`
|
|
- `CarrierJump`
|
|
- `CodexEntry` - But see the separate
|
|
[codexentry schema](./codexentry-README.md) documentation.
|
|
|
|
### Key Renames
|
|
Many of the key names have a different case defined in this schema, make
|
|
sure you are renaming them as appropriate.
|
|
|
|
### Elisions
|
|
#### Remove _Localised key/values
|
|
All keys whose name ends with `_Localised`, i.e. the `Name_Localised`
|
|
key/values in Items.
|
|
|
|
#### Personal data in `Docked` events
|
|
The following keys+values should be removed from `Docked` event data:
|
|
|
|
- `Wanted`
|
|
- `ActiveFine`
|
|
- `CockpitBreach`
|
|
|
|
#### Personal data in `FSDJump` events
|
|
The following keys+values should be removed from `FSDJump` event data:
|
|
|
|
- `Wanted`
|
|
- `BoostUsed`
|
|
- `FuelLevel`
|
|
- `FuelUsed`
|
|
- `JumpDist`
|
|
- `HappiestSystem` from within the list of `Factions`.
|
|
- `HomeSystem` from within the list of `Factions`.
|
|
- `MyReputation` from within the list of `Factions`.
|
|
- `SquadronFaction` from within the list of `Factions`.
|
|
|
|
#### Personal data in `Location` events
|
|
The following keys+values should be removed from `Location` event data:
|
|
|
|
- `Wanted`
|
|
- `Latitude`
|
|
- `Longitude`
|
|
- `HappiestSystem` from within the list of `Factions`.
|
|
- `HomeSystem` from within the list of `Factions`.
|
|
- `MyReputation` from within the list of `Factions`.
|
|
- `SquadronFaction` from within the list of `Factions`.
|
|
|
|
### Augmentations
|
|
#### horizons flag
|
|
You SHOULD add this key/value pair, using the value from the `LoadGame` event.
|
|
|
|
#### odyssey flag
|
|
You SHOULD add this key/value pair, using the value from the `LoadGame` event.
|
|
|
|
#### StarSystem
|
|
If not already present, you MUST add a `StarSystem` string containing the
|
|
name of the system from the last `FSDJump`, `CarrierJump`, or `Location` event.
|
|
|
|
**You MUST apply a location cross-check, as per
|
|
[Other data augmentations](../docs/Developers.md#other-data-augmentations).**
|
|
|
|
This should only apply to `SAASignalsFound` events.
|
|
|
|
#### StarPos
|
|
If not already present, you MUST add a `StarPos` array containing the
|
|
system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location`
|
|
event.
|
|
|
|
**You MUST apply a location cross-check, as per
|
|
[Other data augmentations](../docs/Developers.md#other-data-augmentations).**
|
|
|
|
This should only apply to `Docked`, `Scan` and `SAASignalsFound` events.
|