From 9f7e839b180c461d363cb0aa03815632baded1f6 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Wed, 15 Jul 2020 16:11:03 +0100 Subject: [PATCH] General re-write of Home.md * Re-written opening blurb. * Moved 'Supported platforms' to be second section. * List of supported websites and tools, which doubles up as a glossary of the short names used to refer to them later. * This allowed simplifying (no duplicate links to maintain) the list of functionality. * Added 'click' functionalities to the list. * Closed with a statement about third-party plugins. * Simplified 'Click on' for Ship/System/Station by not mentioning the current choices. No need to update if the list changes. --- Home.md | 95 ++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 71 insertions(+), 24 deletions(-) diff --git a/Home.md b/Home.md index cfeafb0..7624d6b 100644 --- a/Home.md +++ b/Home.md @@ -1,25 +1,14 @@ -# Elite: Dangerous Market Connector (EDMC) +# Elite Dangerous Market Connector (EDMC) -This application downloads your Cmdr's details and system, faction, scan and station data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either: +This is a third-party application for use with +[Frontier Developments](https://www.frontier.co.uk)' +game [Elite Dangerous](https://www.elitedangerous.com/). Its purpose is +to facilitate supplying certain game data to, and in some cases retrieving +it from, a number of websites and other tools. - * sends station commodity market prices, other station data, system and - faction information and body scan data to the - [Elite Dangerous Data Network](https://github.com/EDCD/EDDN/wiki) (“EDDN”) - from where you and others can use it via online trading, prospecting and - shopping tools such as [eddb](https://eddb.io/), - [EDSM](https://www.edsm.net/), - [Elite Trade Net](http://etn.io/), - [Inara](https://inara.cz), - [Roguey's](https://roguey.co.uk/elite-dangerous/), - [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) - - * sends your Cmdr's details, ship details, cargo, materials and flight log to [Elite: Dangerous Star Map](http://www.edsm.net/). - - * sends your Cmdr's details, ship details, cargo, materials, missions, community goal progress, and flight log to [Inara](https://inara.cz). - - * saves station commodity market prices to files on your computer that you can load into trading tools such as [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) or [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools). - - * 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/). +To do this it utilises the Journal Files written by the game when played +on a PC. It also makes use of Frontier's CAPI, accessible once you've +authorised this application. ## Supported Platforms @@ -35,7 +24,63 @@ program, are supported by You can run the application on the same PC on which you're running Elite Dangerous or on another PC connected via a network share. -PS4 and Xbox are not supported. +Consoles, i.e. PS4 and Xbox, are not supported. + +## Supported websites and tools + + * [Elite Dangerous Data Network](https://github.com/EDCD/EDDN/wiki) + (“EDDN”) - relays any data sent to it out to its listeners (EDDB, + Inara, EDSM and others). + * [Elite Dangerous Star Map](https://www.edsm.net/) ("EDSM") - one of + the sites that keeps data about all player-known systems in the game to + facilitate such activities as exploration and trading. + * [Elite: Dangerous Database](https://eddb.io/) (“eddb”) - another of + the general data sites. + * [Inara.cz](https://inara.cz) ("Inara") - another of the general data + sites. + * [Elite & Dangerous Roguey](https://roguey.co.uk/elite-dangerous/) + ("Roguey's") - a collection of tools to assist players with things like + trading. + * [E:D Shipyard](http://edsy.org) ("EDSY") - a website for examining + ship builds and seeing the effects of changes to them. + * [Coriolis.io](http://coriolis.io) ("Coriolis") - another ship builds + tool. + * [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) - + a set of powerful trading tools for Elite Dangerous. + +These are just a few of the third-party tools that have built up around +the game. +The [Elite Dangerous Community Developers](https://edcd.github.io/) +("EDCD" website lists some more, and we're sure there are others. + +## Functionality + + * Optionally saves station commodity market prices to files on your + computer that you can load into trading tools such as Trade Dangerous. + + * Optionally saves a record of your ship loadout to files on your + computer that you can load into outfitting tools such as EDSY or Coriolis. + + * Optionally sends station commodity market prices, other station data, + system and faction information and body scan data to: EDDN, EDSM, Inara. + + * Optionally sends your Cmdr's details, ship details, cargo, materials + and flight log to EDSM. + + * Optionally sends your Cmdr's details, ship details, cargo, materials, + missions, community goal progress, and flight log to Inara. + + * Command-line tool `EDMC.exe` which can be used to save various data + to files or send it over EDDN. See `EDMC.exe -h` for options. + + * Export your current ship's build to either EDSY or Coriolis. + + * View the EDDB, EDSM or Inara page for a game star system. + + * View the EDDB, EDSM or Inara page for a game station. + +There is also support for third-party [plugins](Plugins) which offer +extra functionality. --- # Usage @@ -72,13 +117,14 @@ The user-interface is deliberately minimal - your choice of data is automaticall ## Ship Name Click on the ship name to view its loadout on your chosen 'Shipyard' -provider ([E:D Shipyard](https://edsy.org) (“EDSY”) or [Coriolis](https://coriolis.io)) in your web browser. +provider in your web browser. * Change which provider you use on 'File' > 'Settings' > 'Configuration' (tab) > 'Preferred websites' > 'Shipyard'. ## System name -Click on the system name to view its entry in [Elite: Dangerous Database](https://eddb.io/) (“eddb”), [Elite Dangerous Star Map](https://www.edsm.net/) (“EDSM”) or [Inara](https://inara.cz) in your web browser. +Click on the system name to view its entry on your chosen 'System' +provider in your web browser. * Change which provider you use on 'File' > 'Settings' > 'Configuration' (tab) > 'Preferred websites' > 'System'. @@ -95,7 +141,8 @@ Click on the system name to view its entry in [Elite: Dangerous Database](https: system on EDSM. ## Station name -Click on the station name to view its entry in [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/) or [Inara](https://inara.cz) in your web browser. +Click on the station name to view its entry on your chosen 'Station' +provider in your web browser. * Change which provider you use on 'File' > 'Settings' > 'Configuration' (tab) > 'Preferred websites' > 'Station'.