Schema for Journal entries #48

Merged
merged 3 commits into from Sep 20, 2016

Projects

None yet

2 participants

@Marginal
Contributor
Marginal commented Aug 28, 2016 edited

This schema allows clients to forward interesting entries from the "Commander's Log" Journal to EDDN - i.e. "Docked", "FSDJump" and "Scan" entries. The schema is based on pre-release info so this PR will likely need to be updated during the E:D 2.2 beta run.

About the schema:

  • The schema is deliberately minimal - it doesn't try to describe the content of the journal entries. Clients are expected to pass the Journal entries through essentially unmodified (but see the following points).
  • Some properties from the "Docked" and "FSDJump" Journal entries have been marked as "disallowed" since they're specific to the Cmdr. The sender must strip these properties out of the journal entries before transmitting them over EDDN.
  • The various *_Localised properties have been marked as "disallowed" since they're redundant. The sender must also strip these properties out of the journal entries before transmitting them over EDDN.
  • The "Scan" journal entry contains a "BodyName" property like "Praea Euq NW-W b1-3 3 a", but no "StarSystem" property. Can listeners in all cases unambiguously split the "BodyName" into its system and body constituent parts? The sender must track the current system and add a "StarSystem" property to those Journal entries that lack it (i.e. "Scan" entries).

Here are some example messages in this schema.

@AnthorNet AnthorNet merged commit fff6a35 into jamesremuscat:master Sep 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment