third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-24 12:20:54 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas: commodity: README: Document use of CAPI data

Browse Source
This commit is contained in:
Athanasius 2021-10-29 14:27:40 +01:00
parent 68160fcb8d
commit 8e03a82536
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
schemas/commodity-README.md
View File

@ -15,7 +15,8 @@ So, look for the `Market` event, and when it occurs open and read the
`Market.json` file which contains the actual data. Treat *that* data as
the event.
It *is* also possible to construct this data from a CAPI `/market` query.
It *is* also possible to construct this data from a CAPI `/market` query.
See [Using CAPI data](#using-capi-data) below.
### Key Renames
Many of the key names have a different case defined in this schema, make
@ -44,3 +45,36 @@ Remove not only the `Category_Localised` key/value, as above, but also the
Use the value from the `LoadGame` event.
#### odyssey flag
Use the value from the `LoadGame` event.
### Using CAPI data
It is *not* recommended to use CAPI data as the source as it's fraught with
additional issues. EDMarketConnector does so in order to facilitate
obtaining data without the player needing to open the commodities screen.
1. Retrieve the commander data from the `/profile` CAPI endpoint.
2. Check that `commander['docked']` is true. If not, abort.
3. Retrieve the data from the `/market` and `/shipyard` CAPI endpoints.
4. Compare the system and station name from the CAPI market data to that
from the last `Docked` or `Location` journal event. If either does not
match then you MUST **abort**. This likely indicates that the CAPI data is
lagging behind the game client state and thus should not be used.
Note that CAPI `/market` data will sometimes have the `StatusFlasg` per
item, which are defined as optional in this schema (because they're not in
the Market.json data). You SHOULD include this data in your message if
using CAPI as the source.
Now you will need to construct the necessary additional fields:
#### CAPI horizons flag
You will need to check if any of the economies from the `/market` data have
a `name` are `Colony`, if so, set this flag true.
Additionally, you should retrieve the CAPI `/shipyard` endpoint and check if
any of the listed ships or modules have a `sku` value of
`ELITE_HORIZONS_V_PLANETARY_LANDINGS`. If so, set this flag true.
#### CAPI odyssey flag
Unfortunately there is no method to be *certain* of this from CAPI data, so
you will have to trust in the system/station name check and use the value
from the Journal `LoadGame` event.