Updated English (markdown)

Mathieu B 2019-07-21 20:25:36 +02:00
parent 71bc891e9f
commit 4dbc9c9d70

@ -5,18 +5,19 @@
## **Installation:** ## **Installation:**
**First of all, make sure you have created an application on the[Discord Developer Panel](https://discordapp.com/developers/applications/).** **First of all, make sure you have created an application on the[Discord Developer Panel](https://discordapp.com/developers/applications/).**
- Download the mod [here](https://github.com/M4TH1EU/MinecraftDiscordRichPresence/releases). - Download the mod [here](https://www.curseforge.com/minecraft/mc-mods/custom-rich-presence/).
- Add the mod to your game (in mods/ folder) - Add the mod to your game (in mods/ folder)
- Launch the game one time to generate the config file.
## **Configuration:** ## **Configuration:**
**/!\ Prerequisites : [Installation](#installation)⬆️ /!\\** **/!\ Prerequisites : [Installation](#installation)⬆️ /!\\**
- Go to the folder of your game (example:.minecraft) - Go to the folder of your game (example:.minecraft)
- Go to the config/ folder and open the file ``richpresence.json`` with a text editor. *(avoid the Windows notebook...)* - Go to the mods/ folder and open the file ``MinecraftCustomRichPresence-VX.X-1.12.2.jar.jar`` with 7zip or winrar. *(avoid the Windows default extractor...)*
- Go to config/ folder and open the ``richpresence.json`` with a text editor like Sublime Text *(avoid the Windows notepad...)*
- In this file you will find several parameters and here are more informations about them. - In this file you will find several parameters and here are more informations about them.
Config file : Config file :
*By default the file is in French (because I am French 😄), here I translated the file so you can understand better.
```json ```json
{ {
"_comment": "Avaibles variables:", "_comment": "Avaibles variables:",
@ -56,6 +57,15 @@ Config file :
``` ```
Take it step by step : Take it step by step :
```json
"_comment": "Avaibles variables:",
"_comment2": "%player-name% - Player name.",
"_comment3": "%server-connected-player% - Number of players connected to the server.",
"_comment4": "%server-max-slot% - Number of server slots",
```
If you what to use on of these variables, simply put their names in the ``message`` fields.
```json ```json
"server-ip": "mc.hypixel.net", "server-ip": "mc.hypixel.net",
"server-port": "25565", "server-port": "25565",