mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-07-07 04:08:56 +03:00
Big documentation update:
Installation & Setup: * Reviewed the Installation steps for all OSes. No longer pointing to macOS packages. * Point Linux and macOS users to Running from Source. * Journals location guidance is now here under 'Setup'. * All of the external URLs have been reviewed. etn.io removed as although it loads it no longer seems to actually function. Running from source: * Expand on dependencies... except really it's just the specific Debian command for python3-tk, and pointing out that pip instructions will take care of all the rest.
Athanasius
parent
70ba69c81e
commit
03321abeff
@ -1,55 +1,92 @@
|
||||
Installation
|
||||
===
|
||||
# Installation
|
||||
|
||||
* Windows:
|
||||
## Windows:
|
||||
|
||||
* Requires Windows 7 or later, but note only Windows 10 is tested.
|
||||
* Download the `.msi` package of the [latest release](https://github.com/EDCD/EDMarketConnector/releases/latest).
|
||||
* Double-click on it to install.
|
||||
* Run **Elite Dangerous Market Connector** from the Start Menu or Start Screen.
|
||||
* Requires Windows 7 or later, but only Windows 10 is tested.
|
||||
* Download the `.msi` package of the [latest release](https://github.com/EDCD/EDMarketConnector/releases/latest).
|
||||
* Double-click on it to install.
|
||||
* The application should open at the end of the installation process. Else
|
||||
run **Elite Dangerous Market Connector** from the Start Menu or Start Screen.
|
||||
|
||||
* Windows in custom location, i.e. a different drive:
|
||||
* In Windows "Apps" uninstall "Elite Dangerous Market Connector".
|
||||
* At a Command Prompt type, e.g.:
|
||||
## Windows in custom location, i.e. a different drive:
|
||||
* In Windows "Apps" uninstall "Elite Dangerous Market Connector".
|
||||
* At a Command Prompt type, e.g.:
|
||||
|
||||
`msiexec /i "X:\path\to\EDMarketConnector_win_NNN.msi" INSTALLDIR="Y:\destination\EDMarketConnector`
|
||||
|
||||
Future updates will also be installed to this location.
|
||||
|
||||
## Linux with Steam Play:
|
||||
|
||||
* Linux with Steam Play:
|
||||
* Follow the instructions on [running from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source).
|
||||
* Continue with [Setup](#Setup) below.
|
||||
|
||||
* Copy and paste the following into a Terminal app window:
|
||||
## Linux with Wine:
|
||||
|
||||
`mkdir -p ~/.steam/steam/steamapps/compatdata/359320/pfx/drive_c/users/steamuser/Saved\ Games/Frontier\ Developments/Elite\ Dangerous`
|
||||
* Follow the above instructions for Windows.
|
||||
|
||||
and press Enter (assuming that your Steam library is in the default `~/.steam` location).
|
||||
* (Re)-start the game.
|
||||
* Follow the instructions on [running from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source).
|
||||
* Adjust the “E:D journal file location” setting on the Configuration tab to point to `~/.steam/steam/steamapps/compatdata/359320/pfx/drive_c/users/steamuser/Saved Games/Frontier Developments/Elite Dangerous`.
|
||||
## Mac:
|
||||
|
||||
* Linux with Wine:
|
||||
* You'll need to [run from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source).
|
||||
|
||||
* Follow the above instructions for Windows.
|
||||
---
|
||||
# Setup
|
||||
|
||||
* Mac:
|
||||
## Journals
|
||||
|
||||
* For EDMC 3.44 and later you'll need to [run from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source).
|
||||
* For EDMC 3.43 and earlier there are packages available.
|
||||
* Requires Mac OS 10.10 or later.
|
||||
* Download the `.zip` archive of the [latest release](https://github.com/EDCD/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.
|
||||
This application needs to know where your Game Journal files are in order to
|
||||
function.
|
||||
|
||||
### Windows
|
||||
On Windows these will always be in one standard location, because
|
||||
that's determined by where the game writes them. It will always be:
|
||||
|
||||
Saved Games\Frontier Developments\Elite Dangerous
|
||||
|
||||
and this is the default. To access this reliably in a File Explorer window use
|
||||
the path:
|
||||
|
||||
shell:SavedGames\Frontier Developments\Elite Dangerous\
|
||||
|
||||
*If you ever have a need to move `Saved Games` to another drive then you must
|
||||
do this via the `Properties` on its right-click menu, else neither the game nor
|
||||
this application will be able to find the new location.*
|
||||
|
||||
### Linux
|
||||
If you're running the Game via Steam Play on Linux then your journal files
|
||||
should be located at:
|
||||
|
||||
~/.steam/steam/steamapps/compatdata/359320/pfx/drive_c/users/steamuser/Saved Games/Frontier Developments/Elite Dangerous
|
||||
|
||||
Copy and paste the following into a Terminal app window:
|
||||
|
||||
mkdir -p ~/.steam/steam/steamapps/compatdata/359320/pfx/drive_c/users /steamuser/Saved\ Games/Frontier\ Developments/Elite\ Dangerous
|
||||
|
||||
and press Enter (assuming that your Steam library is in the default `~/.steam` location).
|
||||
|
||||
Now change `Settings` > `Configuration` > `E:D journal file location` to
|
||||
point to there.
|
||||
|
||||
If you have file-shared the Game Journals from another machine that's
|
||||
running the game and mounted them on your Linux machine then you will need to
|
||||
configure this to point to where you mounted them.
|
||||
|
||||
### macOS
|
||||
It has not been possible to run the Game on macOS for many years now, so the
|
||||
only use of this Application is if you have file-shared the Game Journals and
|
||||
mounted them on your macOS machine.
|
||||
|
||||
Thus you will need to configure `Preferences` > `Configuration` >
|
||||
`E:D journal file location` to point to where you have mounted them.
|
||||
|
||||
Setup
|
||||
--------
|
||||
The first time that you run the app while playing the game you are redirected to Frontier's authentication website and prompted for your username and password. This is the same username and password combination that you use to log into the Elite: Dangerous launcher.
|
||||
|
||||
This step is required so that the Frontier servers can send the app *your* data and the data for the station that *you* are docked at. Refer to the [Privacy Policy](Privacy-Policy.md) for how this app handles your data.
|
||||
|
||||
Some options work by reading the Elite: Dangerous game's log files. If you're running this app on a different machine from the Elite: Dangerous game then adjust the “E:D journal file location” setting on the Configuration tab to point to the game's log files.
|
||||
|
||||
### Output
|
||||
---
|
||||
# Output
|
||||
|
||||
This app can save a variety of data in a variety of formats:
|
||||
|
||||
@ -67,28 +104,59 @@ By default these files will be placed in your Documents folder. Since this app w
|
||||
### EDDN
|
||||
|
||||
* Station data
|
||||
* Sends station commodity market, outfitting and shipyard data to “[EDDN](https://github.com/EDCD/EDDN/wiki)” from where you and others can use it via trading tools such as [eddb](http://eddbs.io/), [EDSM](https://www.edsm.net/), [Elite Trade Net](http://etn.io/), [Inara](https://inara.cz), [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools), [Roguey's](https://roguey.co.uk/elite-dangerous/), [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) with the [EDDBlink](https://github.com/eyeonus/Trade-Dangerous/wiki/Plugin-Options#eddblink) plugin, etc.
|
||||
* Sends system and faction information and the results of your planet scans to “[EDDN](https://github.com/EDCD/EDDN/wiki)” from where you and others can use it via online prospecting tools such as [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/), [Inara](https://inara.cz), etc.
|
||||
* You can choose to delay sending this information to EDDN until you're next safely docked at a station. Otherwise the information is sent as soon as you enter a system or perform a scan.
|
||||
* Sends station commodity market, outfitting and shipyard data to
|
||||
[EDDN](https://github.com/EDCD/EDDN/wiki) from where you and others
|
||||
can use it via trading tools such as [eddb](https://eddb.io/),
|
||||
[EDSM](https://www.edsm.net/),
|
||||
[Inara](https://inara.cz/),
|
||||
[mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools),
|
||||
[Roguey's](https://roguey.co.uk/elite-dangerous/),
|
||||
[Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) with the
|
||||
[EDDBlink](https://github.com/eyeonus/Trade-Dangerous/wiki/Plugin-Options#eddblink)
|
||||
plugin, etc.
|
||||
* Sends system and faction information and the results of your planet scans
|
||||
to [EDDN](https://github.com/EDCD/EDDN/wiki) from where you and others
|
||||
can use it via online prospecting tools such as [eddb](https://eddb.io/),
|
||||
[EDSM](https://www.edsm.net/), [Inara](https://inara.cz), etc.
|
||||
* You can choose to delay sending this information to EDDN until you're next
|
||||
docked at a station. Otherwise, the information is sent as soon as you
|
||||
enter a system or perform a scan.
|
||||
|
||||
### EDSM
|
||||
|
||||
You can send a record of your Cmdr's details, ship details, cargo, materials, missions and flight log to [Elite Dangerous Star Map](https://www.edsm.net/). You will need to register for an account and then follow the “[Elite Dangerous Star Map credentials](https://www.edsm.net/settings/api)” link to obtain your API key.
|
||||
You can send a record of your Cmdr's details, ship details, cargo, materials,
|
||||
missions and flight log to [Elite Dangerous Star Map](https://www.edsm.net/).
|
||||
You will need to register for an account and then follow the
|
||||
[Elite Dangerous Star Map credentials](https://www.edsm.net/settings/api)
|
||||
link to obtain your API key.
|
||||
|
||||
### Inara
|
||||
|
||||
You can send a record of your Cmdr's details, ship details, cargo, materials, missions, community goal progress, and flight log to [Inara](https://inara.cz/). You will need to register for an account and then follow the “[Inara credentials](https://inara.cz/settings-api/)” link to obtain your API key. Your flight log on Inara is updated in real-time. Other information is updated on startup and then less frequently - typically on leaving a station.
|
||||
You can send a record of your Cmdr's details, ship details, cargo, materials,
|
||||
missions, community goal progress, and flight log to [Inara](https://inara.cz/).
|
||||
You will need to register for an account and then follow the
|
||||
[Inara credentials](https://inara.cz/settings-api/) link to obtain your API
|
||||
key. Your flight log on Inara is updated in real-time. Other information is
|
||||
updated on startup and then less frequently - typically on leaving a station.
|
||||
|
||||
---
|
||||
# Uninstall
|
||||
## Windows
|
||||
|
||||
Uninstall
|
||||
===
|
||||
Mac:
|
||||
* Uninstall **Elite Dangerous Market Connector** from `Settings`
|
||||
(WinKey+`I`) > `Apps`. NB: Registry keys will remain in place so that you
|
||||
retain all your settings should you re-install.
|
||||
|
||||
* Delete the **EDMarketConnector** app.
|
||||
## Linux
|
||||
You will have installed from source, so simply delete the location you
|
||||
downloaded the source to.
|
||||
|
||||
Windows:
|
||||
## macOS
|
||||
* If you installed the old package (up to version 3.43) then delete the
|
||||
`EDMarketConnector` app.
|
||||
|
||||
* Uninstall **Elite Dangerous Market Connector** from Control Panel → Programs. NB: Registry keys will remain in place.
|
||||
* Else you installed from source and should just
|
||||
remove the folder you downloaded/unpacked it to.
|
||||
|
||||
Note: Uninstalling the app does not delete any output files that it has previously written.
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
#Running from source
|
||||
# Running from source
|
||||
|
||||
You will currently need at least Python 3.7.x to run `stable` code. In order to run
|
||||
`develop` you will need Python 3.8.x or higher (3.9.x has had some testing).
|
||||
@ -32,12 +32,22 @@ On Debian you will need the `python3-pip` package installed.
|
||||
|
||||
Otherwise see [Installing pip](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#installing-pip).
|
||||
|
||||
## Ensure you have tkinter installed
|
||||
## Ensure you have dependencies installed
|
||||
|
||||
### tkinter
|
||||
If using a python.org package it will include this.
|
||||
|
||||
On Debian / Ubuntu / other Debian derivatives the package you need to install
|
||||
is `python3-tk`.
|
||||
On Debian, Ubuntu, and other Debian derivatives the package you need to install
|
||||
is `python3-tk`:
|
||||
|
||||
`sudo apt install python3-tk`
|
||||
|
||||
For other Linux distributions you will need to find the requisite package and
|
||||
how to install it. Keep in mind you need 'tkinter' for 'python3'. Installing
|
||||
'tkinter' for Python 2.7 won't help you.
|
||||
|
||||
### Others
|
||||
All other dependencies will be handled by `pip` below.
|
||||
|
||||
## Obtain a copy of the application source
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user