From a39f24c55d80088d70c752cac85f9f1b468dc470 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 11 Jan 2022 13:13:06 +0000 Subject: [PATCH 1/2] README: Add 'Contact' section at the bottom --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 42978ee..753a90c 100644 --- a/README.md +++ b/README.md @@ -70,3 +70,7 @@ and statistics for, the live service. Hosting is currently provided by the [Elite: Dangerous Community Developers](https://edcd.github.io/). +## Contacting the EDDN team + +* [EDCD Discord](https://discord.gg/XBsdCq9) - **Use the `#eddn` channel**. +* [E:D forum thread](https://forums.frontier.co.uk/threads/elite-dangerous-data-network-eddn.585701/#post-9400060) From 40262322ff2b5a3d38c24e078ab43eb31d3de345 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 11 Jan 2022 13:40:42 +0000 Subject: [PATCH 2/2] README: Expansion and tweaks for replacing the Wiki page * A few uploading PC softwares are listed to lower the barrier for a new player finding such. This is *never* going to be an exhaustive list. * Added section listing console options for contributing data. Again, not intended to be exhaustive. * Layout/sections tweaked. Hopefully the use of double horizontal rules emphasises which section text is a part of. --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 53 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 753a90c..075a46c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # EDDN - Elite Dangerous Data Network ## About EDDN -Elite Dangerous Data Network is a tool that facilitates the players of the game +Elite Dangerous Data Network is a tool that facilitates players of the game [Elite Dangerous](https://www.elitedangerous.com/), including its expansions, sharing data about the game galaxy with others. By pooling data in a common format, tools and analyses can be produced that add @@ -15,17 +15,47 @@ archive or "current state" available to anyone. What it provides is a stream of live data to any interested parties. Some of those then make aggregated data available for general use. +--- --- ## Using EDDN ### Game players -If you are a player of the game and only want to help out by sharing the -data available to you over EDDN then please consult the -[EDCD Cmdr's Guide](https://edcd.github.io/cmdrs-guide.html). For the most -part if you want to share data then you will need to be playing the game on a -PC, but there are some tools that utilise an API provided by the game +It might be useful to consult the [EDCD Cmdr's Guide](https://edcd.github.io/cmdrs-guide.html) +for a general overview of how players can contribute and use game data. + +--- + +#### Contributing data +There are a variety of tools available to players in order for them to help +out by contributing data, and to then utilise that data to enhance their +gameplay experience. + +For the most part any player who wishes to share data +will need to be playing the game on a PC, as that gives direct access to +"Journal" files written by the game client. These are the best source of +game data. +There are, however, some tools that utilise an API provided by the game developer that can supply some data if you are playing on a console. +So, on PC, look into installing one of the following tools: + +- [E:D Market Connector](https://github.com/EDCD/EDMarketConnector/wiki) +- [EDDI](https://github.com/EDCD/EDDI) +- [EDDiscovery](https://github.com/EDDiscovery/EDDiscovery) +- [Elite Log Agent](https://github.com/DarkWanderer/Elite-Log-Agent) + +This list is not exhaustive, or intended to particular endorse any of these +projects over another, listed here or not. + +If you are playing on console some options are: + +- The 'console updater', available in a user's 'dashboard' on + [EDSM](https://www.edsm.net). +- [Journal Limpet](https://journal-limpet.com/). + +--- + +#### Utilising data If you're looking for tools that utilise EDDN data to enhance your experience then you're probably looking for one of the sites listed below. NB: These are listed in name-alphabetical order and no particular ranking or endorsement is @@ -43,9 +73,14 @@ intended. a 'Neutron Star' route plotter, but has since expanded into offering many other route plotting tools and general data searching. -There are many other third-party tools for Elite Dangerous listed on -[Elite: Dangerous Codex](https://edcodex.info/), some of which will -interact with EDDN. Check the [EDDN tag](https://edcodex.info/?m=tools&cat=9). +--- + +There are many other third-party tools for Elite Dangerous, both for +contributing data and utilising it, listed on +[Elite: Dangerous Codex](https://edcodex.info/). Some of them +interact with EDDN - check the [EDDN tag](https://edcodex.info/?m=tools&cat=9). + +--- ### Developers If you are a developer of a third-party tool that could be enhanced by @@ -55,22 +90,26 @@ uploading data to EDDN then please consult **DO NOT** assume that any code or documentation in the `master` (or any other) branch on GitHub truly reflects the current live service! -### Misc +--- +--- + +## Misc + +### Documentation There is also a [wiki page](https://github.com/EDSM-NET/EDDN/wiki), but its contents are currently being migrated into the source code tree (so that they always match the in-use code). +### Service Status Consult [EDDN Status](https://eddn.edcd.io/) for some information about, and statistics for, the live service. ---- - -## Hosting of the live service +### Hosting of the live service Hosting is currently provided by the [Elite: Dangerous Community Developers](https://edcd.github.io/). -## Contacting the EDDN team +### Contacting the EDDN team * [EDCD Discord](https://discord.gg/XBsdCq9) - **Use the `#eddn` channel**. * [E:D forum thread](https://forums.frontier.co.uk/threads/elite-dangerous-data-network-eddn.585701/#post-9400060)