1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 16:27:13 +03:00
EDMarketConnector/README.md
Jonathan Harris e763cbb5cf Doc tweak
2015-06-04 00:01:21 +01:00

3.2 KiB

Elite: Dangerous Market Connector

This app downloads commodity market data from the game Elite: Dangerous and, at your choice, either:

The user-interface is deliberately minimal - just press the "Update" button when you land at a station to automatically download and transmit or save the station's commodity market data:

Windows screenshot Mac screenshot

Installation

Mac:

  • Requires Mac OS 10.9 or later.
  • Download the .zip archive of the latest release.
  • 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 package of the latest release.
  • Double-click on it.
  • Windows 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 on Windows. Run setup.py py2app or setup.py py2exe.

Acknowledgements

  • "Elite: Dangerous" is © 1984 - 2014 Frontier Developments plc.
  • edce-client by Andargor for the idea of using the "Companion" interface.

License

Copyright © 2015 Jonathan Harris.

Licensed under the GNU Public License (GPL) version 2 or later.