mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-04-22 20:00:29 +03:00
Add README.
This commit is contained in:
parent
c21518410d
commit
3e0fe69d80
75
README.md
Normal file
75
README.md
Normal file
@ -0,0 +1,75 @@
|
||||
Elite: Dangerous Market Connector
|
||||
========
|
||||
|
||||
This app downloads commodity market data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either:
|
||||
|
||||
* transmits the data to the Elite Dangerous Data Network ("EDDN") from where you and others can use it via online trading tools such as [eddb](http://eddb.io/).
|
||||
* saves the data to files on your disk which you can load into trading tools such as [Slopey's BPC Market Tool](https://forums.frontier.co.uk/showthread.php?t=53037).
|
||||
|
||||
The user-interface is deliberately minimal - just press the "Update" button to download and automatically transmit/save the commodity market data from the station where you're currently docked in-game:
|
||||
|
||||
 
|
||||
|
||||
|
||||
Installation
|
||||
--------
|
||||
|
||||
Mac:
|
||||
|
||||
* Requires Mac OS 10.9 or later.
|
||||
* Download the `.zip` file of the [latest release](https://github.com/Marginal/EDMarketConnector/releases/latest).
|
||||
* The zip archive contains the **EDMarketConnector** app - move this app to **Applications** or wherever you want it.
|
||||
* Double-click on the app to run it.
|
||||
|
||||
Windows:
|
||||
|
||||
* Requires Windows 7 or later.
|
||||
* Download the `.msi` file of the [latest release](https://github.com/Marginal/EDMarketConnector/releases/latest).
|
||||
* Double-click on it.
|
||||
* The Installer will walk you through the installation process.
|
||||
* Run **EDMarketConnector** from the Start menu.
|
||||
|
||||
|
||||
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. You can also choose here whether to send the market
|
||||
data that you download to EDDN, or to save it locally.
|
||||
|
||||
You are next prompted to authenticate with a "verification code", which you will shortly receive by email from Frontier.
|
||||
Note that each "verification code" is one-time only - if you enter the code incorrectly or quit the app before
|
||||
authenticating you will need to wait for Frontier to send you a new code.
|
||||
|
||||
If you are not prompted to authenticate, but instead see the message "Error: Invalid Credentials" then choose the menu
|
||||
option EDMarketConnector → Preferences (Mac) or File → Settings (Windows) and double-check your username and password.
|
||||
|
||||
Uninstall
|
||||
--------
|
||||
|
||||
Mac:
|
||||
|
||||
* Delete the **EDMarketConnector** app.
|
||||
|
||||
Windows:
|
||||
|
||||
* Uninstall **EDMarketConnector** from Control Panel → Programs.
|
||||
|
||||
|
||||
Running from source & packaging
|
||||
--------
|
||||
The application requires Python 2.7, plus the "requests" module. Run with `python EDMarketConnector.py`.
|
||||
|
||||
To package up for distribution requires py2app 0.9.x on Mac, and py2exe 0.6.x plus the [WiX Toolset](http://wixtoolset.org/) on Windows. Run `setup.py py2app` or `setup.py py2exe`.
|
||||
|
||||
|
||||
Acknowledgements
|
||||
--------
|
||||
* "Elite: Dangerous" is © 1984 - 2014 Frontier Developments plc.
|
||||
* [edce-client](https://github.com/Andargor/edce-client) by [Andargor](https://github.com/Andargor) for the idea
|
||||
of using the "Companion" interface.
|
||||
|
||||
License
|
||||
-------
|
||||
Copyright © 2015 Jonathan Harris.
|
||||
|
||||
Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-2.0.html) version 2 or later.
|
BIN
img/mac.png
Normal file
BIN
img/mac.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 30 KiB |
BIN
img/win.png
Normal file
BIN
img/win.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.3 KiB |
Loading…
x
Reference in New Issue
Block a user