EDNA/README.md

41 lines
1.3 KiB
Markdown
Raw Normal View History

2022-05-29 18:06:13 +02:00
# EDNA An Elite Dangerous System Data Library
2022-05-29 13:34:13 +02:00
2022-05-29 18:06:13 +02:00
EDNA is a library for third party apps that want to access data about star
systems, stations and CMDRs of the game Elite Dangerous. It can query
[EDSM](https://edsm.net), [Spansh](https://spansh.uk) and
[EDTS](http://edts.thargoid.space) for data.
The general idea is that you usually do not care _where_ your data comes from,
so this will get it for you wherever it can depending on data availability and
API features.
**THIS IS A HEAVY WIP PROJECT AND *NOT* READY FOR PRODUCTION USE.** Just saying.
## Why EDNA⁈
Why not. I find it quite funny that most Elite-related project are 4 letter
acronyms starting with “ED”. So I stuck to that, and I had just played “Edna &
Harvey: The Breakout” with the kids. Its not actually an acronym though because
I couldnt come up with a meaning for NA.
2022-05-29 13:34:13 +02:00
## TODO for first proper release
2022-05-29 18:06:13 +02:00
- [x] README
2022-05-29 13:34:13 +02:00
- [ ] Documentation
- [ ] Spansh API
2022-05-29 18:06:13 +02:00
- [ ] system data
- [ ] nearest system
- [ ] station data
- [ ] outdated stations
- [ ] rest (probably out of scope for now)
2022-05-29 13:34:13 +02:00
- [ ] EDSM API
2022-05-29 18:06:13 +02:00
- [x] Systems
- [x] Logs (CMDR data)
- [ ] Stations (probably out of scope for now)
2022-05-29 13:34:13 +02:00
- [x] EDTS API
2022-05-29 18:06:13 +02:00
- [x] system position
- [ ] convenience layer / unification
- [ ] sanity check / refactoring
2022-05-29 13:34:13 +02:00
- [ ] nuget package
2022-05-29 18:06:13 +02:00
- [ ] Github Actions build / package automation