third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-06-14 06:12:11 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: Complete re-write

Browse Source 
* Expand the initial blurb into a full 'About' section.
* Making 'Using EDDN' an actual section, to facilitate migrating away
  from the wiki page.
* Guide players towards some useful information (guide and sites).
* Ensure developers know to check the *live* documentation.
* Explicitly link to the current wiki page and EDDN status.
* Add 'Hosting of the live service' section, and only list the current
  situation (Vivio hosting is 4-5 years ago now, and Anthor's was never
  called out).
This commit is contained in:
Athanasius 2022-01-09 17:24:02 +00:00
parent 084ea35286
commit 1943003b06
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 67 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -1,13 +1,72 @@
## EDDN - Elite: Dangerous Data Network
# EDDN - Elite Dangerous Data Network
The **Elite: Dangerous Data Network** is a system for willing Commanders to share dynamic data about the galaxy with others.
By pooling data in a common format, tools and analyses can be produced that add an even greater depth and vibrancy to the in-game universe.
## About EDDN
Elite Dangerous Data Network is a tool that facilitates the 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
an even greater depth and vibrancy to the in-game universe.
EDDN is not run by or affiliated with [Frontier Developments](http://www.frontier.co.uk/).
EDDN is not run by or affiliated with the developer of the game - [Frontier
Developments](http://www.frontier.co.uk/).
Hosting has been very generously provided by [Vivio Technologies](https://www.viviotech.net/), until 2017.
Hosting is now provided by the [EDCD community](https://edcd.github.io/).
The live EDDN service itself does not store any data, and thus makes no
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](https://github.com/EDSM-NET/EDDN/wiki)
---
## 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
developer that can supply some data if you are playing on a console.
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
intended.
- [EDDB](https://eddb.io/) - a website which tries to act as a database of all
the data available in the game. In general EDDB tries to help finding
stuff which players are looking for.
- [EDSM](https://www.edsm.net/) - originally focused on being a 'Star Map',
but has since expanded its functionality. Of particular interest to
in-game explorers.
- [Inara](https://inara.cz/) - a popular alternative to EDDB, with a lot of
its own unique functionality.
- [Spansh](https://www.spansh.co.uk/plotter) - originally this had one tool,
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).
### Developers
If you are a developer of a third-party tool that could be enhanced by
uploading data to EDDN then please consult
[the live branch documentation](https://github.com/EDCD/EDDN/blob/live/schemas/README-EDDN-schemas.md)
.
**DO NOT** assume that any code or documentation in the `master` (or
any other) branch on GitHub truly reflects the current live service!
### Misc
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).
Consult [EDDN Status](https://eddn.edcd.io/) for some information about,
and statistics for, the live service.
---
## Hosting of the live service
Hosting is currently provided by the
[Elite: Dangerous Community Developers](https://edcd.github.io/).
### [EDDN Status](https://eddn.edcd.io/)