Update README.md
This commit is contained in:
parent
313868f7ab
commit
1db25c40fe
39
README.md
39
README.md
|
@ -1,45 +1,10 @@
|
||||||
# EDMC-Discord-Presence
|
|
||||||
|
|
||||||
A plugin for [Elite Dangerous Market Connector](https://github.com/Marginal/EDMarketConnector) that enables [Discord Rich Presence](https://discordapp.com/rich-presence) for [Elite Dangerous](https://www.elitedangerous.com/)
|
This is a hard fork of [Elite Dangerous Market Connector](https://github.com/Marginal/EDMarketConnector) which adds ship images, and a bunch of extra things to show in your Discord status.
|
||||||
|
|
||||||
Show your current location to your friends on Discord from your user profile.
|
|
||||||
|
|
||||||
![Presence Screenshot](EDMC_Discord_Presence_1.png?raw=true)
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. [Install EDMC according to instructions](https://github.com/Marginal/EDMarketConnector)
|
Just like any other EDMC plugin.
|
||||||
2. Download the latest version of the plugin from [here](https://github.com/SayakMukhopadhyay/EDMC-Discord-Presence/releases). Make sure to download the release `.zip` and not the source code bundle.
|
|
||||||
3. Open Elite Dangerous Market Connector and go to File -> Settings. Then browse to the plugins tab:
|
|
||||||
|
|
||||||
![Plugin Installation](EDMC_Discord_Presence_2.png?raw=true)
|
|
||||||
|
|
||||||
4. Click "Open" to open the plugins directory.
|
|
||||||
5. Open the Zip file we have downloaded and drag the folder from within into the plugins directory
|
|
||||||
6. Restart EDMC for the plugin to take effect.
|
|
||||||
|
|
||||||
To check if the plugin is loaded correctly, go File -> Settings. Then browse to the plugins tab. `DiscordPresence` must be listed under `Enabled Plugins`
|
|
||||||
|
|
||||||
![Plugin Installation Check](EDMC_Discord_Presence_3.png?raw=true)
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
You can set the plugin to not show your game data. Go to File -> Settings. Under the `DiscordPresence` tab, check `Disable Presence`
|
|
||||||
|
|
||||||
![Plugin Disable](EDMC_Discord_Presence_4.png?raw=true)
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
If you find a bug, please create an issue in the issue tracker in Github, properly detailing the bug and reproduction steps.
|
|
||||||
|
|
||||||
If you are willing to contribute to the project, please work on a fork and create a pull request.
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
For the CMDRs by a CMDR. Created by [CMDR Garud](https://forums.frontier.co.uk/member.php/136073-Garud) for an awesome gaming community.
|
|
||||||
A big thanks to [Jonathan Harris (Marginal)](https://github.com/Marginal) for creating the Python boilerplate code for the Discord Rich Presence SDK. Without his input, the plugin would not have been done. Special mention for the awesome group I am in, [Knights of Karma](http://knightsofkarma.com/), for their continuous support.
|
|
||||||
|
|
||||||
Translate to french, migrate from python2 to python3 by [Poneyy](https://github.com/Poneyy)
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue