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

Home: UI - Labelled image, and references to it.

Athanasius 2021-05-12 16:33:57 +01:00
parent b3ac414062
commit a570c20aa8
1 changed files with 68 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
Home.md

@ -121,8 +121,44 @@ filled in.
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.
![labelled UI image](https://github.com/EDCD/EDMarketConnector/raw/main/img/UI-annotated.png)
1. [Menus](#menus)
2. [Commander Name](#commander-name)
3. [Ship Name](#ship-name)
4. [Suit type name](#suit-name-odyssey), if applicable.
5. [Suit loadout name](#suit-name-odyssey), if applicable.
6. [Current system's name](#system-name), if applicable.
7. [Current station's name](#station-name), if applicable.
8. [Update button](#update-button), or cooldown timer.
9. [Status text](#bottom-status-line) line.
We'll refer to the labels on this image below.
## Menus
The application has three menus, labelled `1` in the image above.
1. `File`
1. `Status` - displays some information about your Cmdr and owned ships.
1. `Save Raw Data` - Saves the last retrieved CAPI (Frontier API) data
to a file in the folder configured in the `Output` tab of `Settings`.
1. `Settings` - opens the Settings/Preferences/configuration dialogue.
1. `Edit`
1. `Copy` - copies the current system name, and station name if
applicable, to the clipboard, separated by a comma, e.g. `LFT 1748,
Chomsky Enterprise`.
1. `Help`
1. `Documentation` - opens this page in a browser.
1. `Privacy Policy` - opens our privacy policy statement in a browser.
1. `Release Notes` - opens our [GitHub Releases](https://github.com/EDCD/EDMarketConnector/releases) page.
1. `Check for Updates...` - performs a manual check for application
updates on Windows. Only stable, full releases will be considered.
1. `About E:D Market Connector` - Display application name, version,
version-specific release notes link, and copyright information.
## Commander Name
This is the part of the UI with the label "Cmdr:".
This is the part of the UI with the label "Cmdr:". The text is the element
labelled `2` in the image above.
If you aren't in a Private Group, nor taking part in Multi-Crew, then
the text to the right of the label will simply show your current Commander's
@ -140,9 +176,9 @@ You can differentiate this from the Private Group case by checking if you
have a 'Ship:' or 'Role:' label, see below.
## Ship Name
The text next to the label 'Ship:' will contain either the model of
your ship, or if you have set a ship name in the game 'Livery'
interface it will show that instead.
The text next to the label 'Ship:', labelled 3` in the image above, will
contain either the model of your ship, or if you have set a ship name in the
game 'Livery' interface it will show that instead.
Unless this text is greyed out (indicating we don't yet have loadout
information for the ship) you can click on the ship name to view its
@ -156,7 +192,21 @@ the label will change to 'Role:' and the text will be the role you're
currently fulfilling on the ship. You **cannot** click the text to
access the build of the ship you're Multi-Crewing in.
## Suit Name (Odyssey)
If you are playing Elite Dangerous Odyssey and the application has read
data about your current suit and loadout then an additional line (`4` and
`5` in the image above) will appear on the UI.
If you're not playing Odyssey then this line will not appear in the UI.
The text labelled `4` is the name of the type of suit you're wearing. The
text labelled `5`, in parantheses, is the name of the currently equipped
suit loadout.
## System name
The name of the star system you're currently in appears as per label `6` on
the image above.
Click on the system name to view its entry on your chosen 'System'
provider in your web browser.
@ -175,6 +225,15 @@ provider in your web browser.
system on EDSM.
## Station name
The text labelled `7` on the image above will be one of:
1. the name of the station you're docked in if you are docked.
1. A 'multiply' symbol `×` if you are in a system that is known to have
at least one station/landable port, but aren't docked at any.
1. Blank/empty if in a system not known to have any stations or landable
ports.
Click on the station name to view its entry on your chosen 'Station'
provider in your web browser.
@ -191,7 +250,7 @@ provider in your web browser.
## Update button
This button will not be available until
This button, labelled `8` on the image above, will not be available until
[Frontier Authentication](Troubleshooting#problems-with-frontier-authentication)
is completed for the currently active Commander.
@ -213,8 +272,10 @@ immediately or at all.
## Bottom status line
The bottom-most line of EDMC, just below the 'Update' button, is used
for short messages conveying status information and/or errors.
The bottom-most line of EDMC, labelled `9` on the image above, is used
for short messages conveying status information and/or errors. In the
image it is showing the local time of the last data update used to send
information to EDDN etc.
## If you encounter problems