mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-04-12 07:20:02 +03:00
73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
Any questions or offers of help can be directed to the EDCD Discord #edmc
|
|
channel:
|
|
|
|
[](https://discord.gg/usQ5e6n)
|
|
|
|
Elite: Dangerous Market Connector (EDMC)
|
|
===
|
|
|
|
This application is only of use to PC players of the game Elite Dangerous
|
|
(and its expansions). It won't work with PS4 or Xbox accounts.
|
|
|
|
It utilises the Journal files written by the game on the user's computer,
|
|
together with data from the API Frontier Developments supplies in order to
|
|
feed this data to various third party sites that the user may find useful.
|
|
|
|
See [the Wiki documentation](https://github.com/EDCD/EDMarketConnector/wiki)
|
|
for more details.
|
|
|
|
|
|
Installation & Uninstall
|
|
---
|
|
Please see the [Installation & Setup](https://github.com/EDCD/EDMarketConnector/wiki/Installation-&-Setup) wiki page.
|
|
|
|
|
|
Running from source
|
|
---
|
|
Please see the [Running from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source) wiki page.
|
|
|
|
|
|
Plugins
|
|
---
|
|
Plugins extend the behaviour of this app. See the [Plugins](https://github.com/EDCD/EDMarketConnector/wiki/Plugins) wiki page for more information.
|
|
|
|
If you would like to write a plugin please see [PLUGINS.md](PLUGINS.md).
|
|
|
|
|
|
Troubleshooting
|
|
---
|
|
Please see the [Troubleshooting](https://github.com/EDCD/EDMarketConnector/wiki/Troubleshooting) wiki page.
|
|
|
|
|
|
Reporting a problem
|
|
---
|
|
Please report a problem as a new GitHub [issue](https://github.com/EDCD/EDMarketConnector/issues/new?assignees=&labels=bug%2C+unconfirmed&template=bug_report.md&title=).
|
|
See [Reporting a problem](https://github.com/EDCD/EDMarketConnector/wiki/Troubleshooting#reporting-a-problem)
|
|
for further guidance, including how to find the necessary log files to
|
|
attach to the report.
|
|
|
|
Packaging for distribution
|
|
--------
|
|
Please see [docs/Releasing.md](docs/Releasing.md).
|
|
|
|
Disclaimer
|
|
--------
|
|
This app uses the “Companion” web API that Frontier originally supplied for
|
|
their Elite Dangerous iOS app and now [support](https://forums.frontier.co.uk/threads/open-letter-to-frontier-developments.218658/page-19#post-3371472)
|
|
for third-party apps. If that API ceases to function in the future then
|
|
much of this application's functionality will be curtailed (although it
|
|
could still utilise [Journal files](https://forums.frontier.co.uk/threads/commanders-log-manual-and-data-sample.275151/#post4562494)).
|
|
|
|
|
|
|
|
|
|
Acknowledgements
|
|
--------
|
|
Please see the [Acknowledgements](https://github.com/EDCD/EDMarketConnector/wiki/Acknowledgements-&-License) wiki page.
|
|
|
|
License
|
|
-------
|
|
Copyright © 2015-2019 Jonathan Harris, 2020-2024 EDCD
|
|
|
|
Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-2.0.html) version 2 or later.
|