mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-04-15 00:30:33 +03:00
Update docs
Document changing log file location. Remove troubleshooting issues fixed in 2.1. Remove flight log file. Remove edproxy.
This commit is contained in:
Jonathan Harris
parent
d45705de8b
commit
e674113d99
67
README.md
67
README.md
@ -1,12 +1,14 @@
|
||||
Elite: Dangerous Market Connector (EDMC)
|
||||
========
|
||||
|
||||
This app downloads commodity market and other station data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either:
|
||||
This app downloads your data and station data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either:
|
||||
|
||||
* sends the data to the [Elite Dangerous Data Network](http://eddn-gateway.elite-markets.net/) (“EDDN”) from where you and others can use it via online trading tools such as [eddb](http://eddb.io/), [Elite Trade Net](http://etn.io/), [Inara](http://inara.cz), [ED-TD](http://ed-td.space/), [Roguey's](http://roguey.co.uk/elite-dangerous/), etc.
|
||||
* saves the data to files on your computer that you can load into trading tools such as [Slopey's BPC Market Tool](https://forums.frontier.co.uk/showthread.php?t=76081), [Trade Dangerous](https://bitbucket.org/kfsone/tradedangerous/wiki/Home), [Thrudd's Trading Tools](http://www.elitetradingtool.co.uk/), [Inara](http://inara.cz), [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools), etc.
|
||||
* saves a record of your ship loadout to files on your computer that you can load into [E:D Shipyard](http://www.edshipyard.com), [Coriolis](http://coriolis.io) or [Elite Trade Net](http://etn.io/).
|
||||
* saves your flight log to a file on your computer and/or sends it to [Elite: Dangerous Star Map](http://www.edsm.net/).
|
||||
* sends the station commodity market prices and other station data to the [Elite Dangerous Data Network](http://eddn-gateway.elite-markets.net/) (“EDDN”) from where you and others can use it via online trading and shopping tools such as [eddb](http://eddb.io/), [Elite Trade Net](http://etn.io/), [Inara](http://inara.cz), [ED-TD](http://ed-td.space/), [Thrudd's Trading Tools](http://www.elitetradingtool.co.uk/), [Roguey's](http://roguey.co.uk/elite-dangerous/), etc.
|
||||
* saves the station market prices to files on your computer that you can load into trading tools such as [Slopey's BPC Market Tool](https://forums.frontier.co.uk/showthread.php?t=76081), [Trade Dangerous](https://bitbucket.org/kfsone/tradedangerous/wiki/Home), [Thrudd's Trading Tools](http://www.elitetradingtool.co.uk/), [Inara](http://inara.cz), [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools), etc.
|
||||
* 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 your flight log to [Elite: Dangerous Star Map](http://www.edsm.net/).
|
||||
|
||||
You can run the app on the same machine on which you're running Elite: Dangerous or on another machine connected via a network share.
|
||||
|
||||
Usage
|
||||
--------
|
||||
@ -42,7 +44,7 @@ Windows:
|
||||
Setup
|
||||
--------
|
||||
The first time that you run the app you are prompted for your username and password. This is the same username and password
|
||||
combination that you use to log into the Elite: Dangerous launcher, and is required so that the Frontier servers can send the app *your* data and the market data for the station that *you* are docked at.
|
||||
combination that you use to log into the Elite: Dangerous launcher, and is required so that the Frontier servers can send the app *your* data and the data for the station that *you* are docked at.
|
||||
|
||||
You can also choose here what data to save (refer to the next section for details), whether to “Update” automatically on docking and/or with a hotkey, and whether to attach your Cmdr name or a [pseudo-anonymized](http://en.wikipedia.org/wiki/Pseudonymity) ID to the data.
|
||||
|
||||
@ -57,8 +59,8 @@ Output
|
||||
--------
|
||||
This app can save a variety of data in a variety of formats:
|
||||
|
||||
* Market data
|
||||
* Elite Dangerous Data Network - sends commodity market, outfitting and shipyard data to “[EDDN](http://eddn-gateway.elite-markets.net/)” from where you and others can use it via online trading tools such as [eddb](http://eddb.io/), [Elite Trade Net](http://etn.io/), [Inara](http://inara.cz), [ED-TD](http://ed-td.space/), [Roguey's](http://roguey.co.uk/elite-dangerous/), etc.
|
||||
* Station data
|
||||
* Elite Dangerous Data Network - sends station commodity market, outfitting and shipyard data to “[EDDN](http://eddn-gateway.elite-markets.net/)” from where you and others can use it via online trading tools such as [eddb](http://eddb.io/), [Elite Trade Net](http://etn.io/), [Inara](http://inara.cz), [ED-TD](http://ed-td.space/), [Thrudd's Trading Tools](http://www.elitetradingtool.co.uk/), [Roguey's](http://roguey.co.uk/elite-dangerous/), etc.
|
||||
* Slopey's BPC format file - saves commodity market data as files that you can load into [Slopey's BPC Market Tool](https://forums.frontier.co.uk/showthread.php?t=76081).
|
||||
* Trade Dangerous format file - saves commodity market data as files that you can load into [Trade Dangerous](https://bitbucket.org/kfsone/tradedangerous/wiki/Home).
|
||||
* CSV format file - saves commodity market data as files that you can upload to [Thrudd's Trading Tools](http://www.elitetradingtool.co.uk/), [Inara](http://inara.cz) or [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools).
|
||||
@ -66,17 +68,12 @@ This app can save a variety of data in a variety of formats:
|
||||
* Ship loadout
|
||||
* After every outfitting change saves a record of your ship loadout as a file that you can open in a text editor and that you can import into [E:D Shipyard](http://www.edshipyard.com), [Coriolis](http://coriolis.io) or [Elite Trade Net](http://etn.io/).
|
||||
|
||||
* Flight log
|
||||
* CSV format file - adds a record of your location, ship and cargo to a file that you can open in a text editor or a spreadsheet program such as Excel. Note: Don't edit, rename or move this file - take a copy if you wish to change it.
|
||||
|
||||
By default these files will be placed in your Documents folder. Since this app will create a lot of files if you use it for a while you may wish to create a separate folder for the files and tell the app to place them there.
|
||||
|
||||
EDSM
|
||||
--------
|
||||
You can send a record of your location to [Elite: Dangerous Star Map](http://www.edsm.net/) where you can view your flight log under My account → Exploration Logs and optionally add private comments about a system. You will need to register for an account and follow the “[Elite Dangerous Star Map credentials](http://www.edsm.net/settings/api)” link to obtain your API key.
|
||||
|
||||
If you select “Automatically make a log entry on entering a system” EDMC will pick up system changes from either Elite: Dangerous' log files or from [edproxy](https://bitbucket.org/westokyo/edproxy/) if it's running on the same subnet and if your router allows Multicast packets.
|
||||
|
||||
|
||||
Uninstall
|
||||
--------
|
||||
@ -108,59 +105,25 @@ Refer to [PLUGINS.md](PLUGINS.md) if you would like to write a plugin.
|
||||
Troubleshooting
|
||||
--------
|
||||
|
||||
### Can't Update - "Invalid Credentials"
|
||||
Some people find that they can log-in and receive a verification code from Frontier. But on hitting “Update” they see an "Invalid Credentials" error.
|
||||
|
||||
If you've purchased Horizons (without Season 1) **on Steam** you may be able to solve this error by:
|
||||
|
||||
* Logging on to Steam.
|
||||
* Check that you have both an Elite: Dangerous and a Horizons DLC key.
|
||||
* In the [Partner Keys](https://www.frontierstore.net/eur/frontier_partnerkeys/) section of the Frontier Store add the base Elite: Dangerous key.
|
||||
|
||||
If you've purchased Horizons (without Season 1) from **the Frontier store** you may be able to solve this error by:
|
||||
|
||||
* Registering with / logging on to Steam.
|
||||
* In the [Partner Keys](https://www.frontierstore.net/eur/frontier_partnerkeys/) section of the Frontier Store link your Frontier account to your Steam account.
|
||||
* Note that you can still play Horizons using your existing launcher and Frontier login.
|
||||
|
||||
This problem is tracked as [Issue #43](https://github.com/Marginal/EDMarketConnector/issues/43).
|
||||
|
||||
### Can't see commodities market at some Outposts - "Can't get market data!"
|
||||
The Frontier server that supplies the data to this app fails to supply commodity data for some outposts - particularly industrial and mining outposts. This is a [known bug](https://forums.frontier.co.uk/showthread.php?t=195774) in Frontier's servers.
|
||||
|
||||
This problem is tracked as [Issue #6](https://github.com/Marginal/EDMarketConnector/issues/6).
|
||||
|
||||
### Shipyard data not reported
|
||||
The Frontier server that supplies the data to this app sometimes fails to supply shipyard data. Visit the shipyard in-game and try “Updating” again.
|
||||
|
||||
This problem is tracked as [Issue #86](https://github.com/Marginal/EDMarketConnector/issues/86).
|
||||
|
||||
### Rares profits wiped out
|
||||
Due to a bug in the server that supplies the data to this app, profit on any Rare cargo in your hold is wiped out when you visit the in-game Commodity Market after having “Updated”.
|
||||
Due to a bug in the server that supplies the data to this app, profit on any Rare cargo in your hold may be wiped out when you visit the in-game Commodity Market after having “Updated”.
|
||||
|
||||
Ensure that you visit the in-game Commodity Market at a station where you intend to sell Rares **before** hitting “Update”.
|
||||
|
||||
This problem is tracked as [Issue #92](https://github.com/Marginal/EDMarketConnector/issues/92).
|
||||
|
||||
### Doesn't track Systems visited
|
||||
When you have the "Automatically make a log entry on entering a system" option selected this app uses Elite: Dangerous' logs to track and display the systems that you visit. Some people find that this doesn't work. The problem is most likely due to using the logs from a different copy of Elite: Dangerous than the copy that you're running.
|
||||
|
||||
When looking for the log files, this app assumes:
|
||||
This app uses Elite: Dangerous' log files to track and display the systems that you visit. When looking for the log files, this app assumes:
|
||||
|
||||
- That you're running under Steam, if you have both Steam and non-Steam versions installed.
|
||||
- That you're running "Horizons" 64bit, if you have both Horizons and Season 1 installed.
|
||||
- That you're running from Steam, if you have both Steam and non-Steam versions installed.
|
||||
|
||||
In more detail, this app looks for the folder `elite-dangerous-64` in the following places:
|
||||
|
||||
1. In the `Elite Dangerous\Products` folder under Steam (in English versions of Windows usually `C:\Program Files (x86)\Steam\steamapps\common\Elite Dangerous\Products`) and under each Steam library.
|
||||
2. In the `Products` folder under the launcher (in English versions of Windows usually `C:\Program Files (x86)\Frontier\EDLaunch\Products`).
|
||||
3. `%PROGRAMFILES(X86)%\Frontier\Products` (in English versions of Windows usually `C:\Program Files (x86)\Frontier\Products`).
|
||||
4. `%LOCALAPPDATA%\Frontier_Developments\Products` (usually `C:\Users\you\AppData\Local\Frontier_Developments\Products`).
|
||||
|
||||
EDMC expects the `elite-dangerous-64` folder to contain the file AppConfig.xml and a Logs subfolder. It stops looking once it finds an `elite-dangerous-64` folder that meets these criteria.
|
||||
|
||||
If it doesn't find `elite-dangerous-64` in the above places it looks for a folder starting with `FORC-FDEV-D-1` in the same places.
|
||||
|
||||
If you find that this app isn't automatically tracking the systems that you visit and/or isn't automatically “updating” on docking (if you have that option selected), or if you're running this app on a different machine from the Elite: Dangerous game then adjust the “E:D log file location” setting to point to the game's log files using [this info](https://support.frontier.co.uk/kb/faq.php?id=108) as a guide.
|
||||
|
||||
Running from source
|
||||
--------
|
||||
@ -257,6 +220,6 @@ Acknowledgements
|
||||
|
||||
License
|
||||
-------
|
||||
Copyright © 2015 Jonathan Harris.
|
||||
Copyright © 2015-2016 Jonathan Harris.
|
||||
|
||||
Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-2.0.html) version 2 or later.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user