ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-22 11:50:28 +03:00
Code Issues Projects Releases Wiki Activity

Expand on 'Usage' instructions 

* Move Discord link to 'support here' at the bottom.
 * Space out the list of what the app does with data.
 * Clarify about starting the app before, and caveat.
 * Correct EDSY and Coriolis URLs.
 * Document what the 'x' as Station Name means.
 * Clarify what the purpose of the 'Update' button is.
Athanasius 2020-07-09 16:51:21 +01:00
parent 66a1acff3f
commit 86f9ec3a21
1 changed files with 55 additions and 15 deletions

70
Home.md

@ -1,34 +1,74 @@
[![Discord chat](https://img.shields.io/discord/164411426939600896.svg?style=social&label=Discord%20chat)](https://discord.gg/usQ5e6n)
Elite: Dangerous Market Connector (EDMC)
========
# Elite: Dangerous Market Connector (EDMC)
This app downloads your Cmdr's details and system, faction, scan and station data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either:
* sends station commodity market prices, other station data, system and faction information and body scan data to the [Elite Dangerous Data Network](https://github.com/EDSM-NET/EDDN/wiki) (“EDDN”) from where you and others can use it via online trading, prospecting and shopping tools such as [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/), [Elite Trade Net](http://etn.io/), [Inara](https://inara.cz), [Roguey's](https://roguey.co.uk/elite-dangerous/), [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki), etc.
* sends your Cmdr's details, ship details, cargo, materials and flight log to [Elite: Dangerous Star Map](http://www.edsm.net/).
* sends your Cmdr's details, ship details, cargo, materials, missions, community goal progress, and flight log to [Inara](https://inara.cz).
* saves station commodity market prices to files on your computer that you can load into trading tools such as [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) or [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools).
* saves a record of your ship loadout to files on your computer that you can load into outfitting tools such as [E:D Shipyard](http://www.edshipyard.com), [Coriolis](http://coriolis.io) or [Elite Trade Net](http://etn.io/).
* sends station commodity market prices, other station data, system and faction information and body scan data to the [Elite Dangerous Data Network](https://github.com/EDSM-NET/EDDN/wiki) (“EDDN”) from where you and others can use it via online trading, prospecting and shopping tools such as [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/), [Elite Trade Net](http://etn.io/), [Inara](https://inara.cz), [Roguey's](https://roguey.co.uk/elite-dangerous/), [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki), etc.
* sends your Cmdr's details, ship details, cargo, materials and flight log to [Elite: Dangerous Star Map](http://www.edsm.net/).
* sends your Cmdr's details, ship details, cargo, materials, missions, community goal progress, and flight log to [Inara](https://inara.cz).
* saves station commodity market prices to files on your computer that you can load into trading tools such as [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) or [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools).
* saves a record of your ship loadout to files on your computer that you can load into outfitting tools such as [E:D Shipyard](http://www.edshipyard.com), [Coriolis](http://coriolis.io) or [Elite Trade Net](http://etn.io/).
You can run the app on the same PC or Mac on which you're running Elite: Dangerous or on another PC connected via a network share. PS4 and Xbox are not supported, sorry.
---
# Usage
Usage
--------
The user-interface is deliberately minimal - your choice of data is automatically downloaded, transmitted and/or saved when you start Elite: Dangerous, land at a station, jump to a system or scan a body. Start the app before entering the game to ensure that you don't miss any data - some data is only available at game start.
Start the app before entering the game to ensure that you don't miss any
data - some data is only available at game start.
Click on the ship name to view its loadout on [E:D Shipyard](http://www.edshipyard.com) (“EDSY”) or [Coriolis](https://coriolis.edcd.io) in your web browser.
However you will need your most recent game session to have included
logging all the way into the game in order to set up some of this
applications options. See
[Troubleshooting - Credentials settings are greyed out](Troubleshooting#credentials-settings-are-greyed-out)
The user-interface is deliberately minimal - your choice of data is automatically downloaded, transmitted and/or saved when you start Elite: Dangerous, land at a station, jump to a system or scan a body.
## Ship Name
Click on the ship name to view its loadout on [E:D Shipyard](https://edsy.org) (“EDSY”) or [Coriolis](https://coriolis.io) in your web browser.
## System name
Click on the system name to view its entry in [Elite: Dangerous Database](https://eddb.io/) (“eddb”), [Elite Dangerous Star Map](https://www.edsm.net/) (“EDSM”) or [Inara](https://inara.cz) in your web browser.
## Station name
Click on the station name to view its entry in [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/) or [Inara](https://inara.cz) in your web browser.
NB: This only works whilst docked. You might see an `×`
character as the name sometimes when not docked. This means the application
has determined that you're in a populated system and clicking this `×`
will open the *system* page so you can see a listing of stations in it.
## Update button
*Remember, the application will automatically respond to game data so as
to udpate and/or send it as needed*. Under normal circumstances you
won't ever need to press this button.
But if, for instance, you've been docked in a station for 15 minutes and
want to ensure that EDDB etc have the latest commodities information
then you can press the 'Update' button to trigger this.
There is an enforced cooldown on how often you can do this so as to not
over-tax the Frontier CAPI service.
Plugins might have their own internal cooldowns or queues which
cause pressing this button to not necessarily send/update data.
---
![Windows screenshot](https://github.com/EDCD/EDMarketConnector/raw/master/img/win.png)   ![Mac screenshot](https://github.com/EDCD/EDMarketConnector/raw/master/img/mac.png)
![Windows screenshot](https://github.com/EDCD/EDMarketConnector/raw/master/img/win_dark.png)   ![Mac screenshot](https://github.com/EDCD/EDMarketConnector/raw/master/img/mac_dark.png)
![Windows screenshot](https://github.com/EDCD/EDMarketConnector/raw/master/img/win_transparent.png)
[Get started](Installation-&-Setup)
--------
---
# Miscellaneous
To get started with the application see[Installation & Setup](Installation-&-Setup)
Support is available in the #edmc channel of the
[![Discord chat](https://img.shields.io/discord/164411426939600896.svg?style=social&label=Discord%20chat)](https://discord.gg/usQ5e6n)
for [EDCD (Elite Dangerous Community Developers)](https://edcd.github.io/).