Add english wiki

2019-07-20 23:55:09 +02:00 · 2019-07-20 23:55:09 +02:00 · 3c72992fdb
commit 3c72992fdb
parent 57a928fdd3
1 changed files with 112 additions and 0 deletions
--- a/English.md
+++ b/English.md
@ -0,0 +1,112 @@
+
+
+![https://i.imgur.com/jihvq3E.png](https://i.imgur.com/jihvq3E.png "Logo")
+# Welcome to the MinecraftDiscordRichPresence wiki!
+## **Installation:**
+**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).
+- Add the mod to your game (in mods/ folder)
+- Launch the game one time to generate the config file.
+
+## **Configuration:**
+
+**/!\ Prerequisites : [Installation](#installation)⬆️ /!\\**
+- 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...)*
+- In this file you will find several parameters and here are more informations about them.
+
+Config file :
+```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",
+  "server-ip": "mc.hypixel.net",
+  "server-port": "25565",
+  "application-settings": {
+    "applicationID": "601875975533232158",
+    "large-image-name": "discord_logo",
+    "large-image-text": "Testing this mod !"
+  },
+  "advanced-status-custom": {
+    "onJoinServer": {
+      "enable": true,
+      "message": "In game."
+    },
+    "onQuitServer": {
+      "enable": true,
+      "message": "In mainmenu."
+    },
+    "inPauseMenu": {
+      "enable": true,
+      "message": "In pause menu"
+    },
+    "inMainMenu": {
+      "enable": true,
+      "message": "In mainmenu"
+    },
+    "inInventory": {
+      "enable": false,
+      "message": "In inventory"
+    }
+  }
+}
+```
+
+Take it step by step :
+```json
+"server-ip": "mc.hypixel.net",
+"server-port": "25565",
+```
+Here you can define the IP address and port of your server if you want to use the variables ``%server-connected-player%`` and/or ``%server-max-slot%``.
+
+```json
+"application-settings": {
+    "applicationID": "601875975533232158",
+    "large-image-name": "discord_logo",
+    "large-image-text": "Testing this mod !"
+  },
+```
+
+This part is very important, it is the one that will tell the mod which application to display on your profile. 
+- ``applicationID`` is the "Client ID" that you can find on the main page of your application on the Discord developer panel.
+- ``large-image-name`` is the name you have given [to the image you want to display in bulk on your profile](https://imgur.com/G9pWLLa) in the [Rich Presence -> Art Assets](https://i.imgur.com/MtjQL9u.png) menu of your Discord application.
+- ``large-image-text`` is the text you want to display on your profile[when you move your mouse over the image] (https://i.imgur.com/KnGFdpX
+
+```json
+  "advanced-status-custom": {
+    "onJoinServer": {
+      "enable": true,
+      "message": "In game."
+    },
+    "onQuitServer": {
+      "enable": true,
+      "message": "In mainmenu."
+    },
+    "inPauseMenu": {
+      "enable": true,
+      "message": "In pause menu"
+    },
+    "inMainMenu": {
+      "enable": true,
+      "message": "In mainmenu"
+    },
+    "inInventory": {
+      "enable": false,
+      "message": "In inventory"
+    }
+```
+
+This section will be used to display additional information about your Discord profile. Like [that](https://i.imgur.com/xHJeZ39.png) for example.
+There are several "blocks":
+- ``onJoinServer`` : When the player join a server
+- ``onQuitServer`` : When the player quit a server (Risk of being deleted because same utility as ``inMainMenu``).
+- ``inPauseMenu`` : When the player open the pause menu (ESC).
+- ``inMainMenu`` : When the player is in the mainmenu.
+- ``inInventory`` : When the player open his inventory.
+
+You will see an ``enable`` variable in each "block", the latter is used to activate or we activate the "block" in question.
+
+If you have a problem, come see me on Discord -> ``M4TH1EU#0001``