Updated Home (markdown)

2019-07-20 23:28:26 +02:00 · 2019-07-20 23:28:26 +02:00 · c15d9067a6
commit c15d9067a6
parent 125fec9996
1 changed files with 95 additions and 7 deletions
--- a/Home.md
+++ b/Home.md
@ -13,13 +13,101 @@ Bienvenue sur le wiki de MinecraftDiscordRichPresence!

 **/!\ Prérequis : [Installation](#installation)⬆️ /!\\**
 - Rendez vous dans le dossier de votre jeu (exemple: .minecraft)
- Puis aller dans le dossier config/ et ouvrez le fichier ``richpresence.cfg`` avec un éditeur de texte. *(évitez le bloc-notes de windows...)*
+- Rendez-vous dans le dossier config/ et ouvrez le fichier ``richpresence.json`` avec un éditeur de texte. *(évitez le bloc-notes de windows...)*
 - Dans ce fichier vous aller retrouver plusieurs paramètres et voici plus d'infos sur ces derniers.

+Fichier de config :
+```json
+{
+  "_comment": "Variables disponibles :",
+  "_comment2": "%player-name% - Nom du joueur.",
+  "_comment3": "%server-connected-player% - Nombre de joueur connecté au serveur.",
+  "_comment4": "%server-max-slot% - Nombre de slots du serveur",
+  "server-ip": "mc.hypixel.net",
+  "server-port": "25565",
+  "application-settings": {
+    "applicationID": "601875975533232158",
+    "large-image-name": "discord_logo",
+    "large-image-text": "En train de tester ce mod !"
+  },
+  "advanced-status-custom": {
+    "onJoinServer": {
+      "enable": true,
+      "message": "En jeu."
+    },
+    "onQuitServer": {
+      "enable": true,
+      "message": "Dans le menu principal."
+    },
+    "inPauseMenu": {
+      "enable": true,
+      "message": "Dans le menu pause."
+    },
+    "inMainMenu": {
+      "enable": true,
+      "message": "Dans le menu principal."
+    },
+    "inInventory": {
+      "enable": false,
+      "message": "Dans l'inventaire."
+    }
+  }
+}
+```
+
+Prennons le bout par bout : 
+```json
+"server-ip": "mc.hypixel.net",
+"server-port": "25565",
+```
+Ici vous pouvez définir l'adresse IP et le port de votre serveur si vous souhaitez utiliser les variables ``%server-connected-player%`` et/ou ``%server-max-slot%``.
+
+```json
+"application-settings": {
+    "applicationID": "601875975533232158",
+    "large-image-name": "discord_logo",
+    "large-image-text": "En train de tester ce mod !"
+  },
+```
+Cette partie est très importante, c'est celle qui va indiquer au mod quelle application afficher sur votre profile. 
+- ``applicationID`` correspond au "Client ID" que vous pouvez retrouvez sur la page principale de votre application sur le panel développeur de Discord.
+- ``large-image-name`` correspond au nom que vous avez donné [à l'image que vous voulez afficher en gros sur votre profile](https://imgur.com/G9pWLLa) dans le menu [Rich Presence -> Art Assets](https://i.imgur.com/MtjQL9u.png) de votre application Discord.
+- ``large-image-text`` correspond au texte que vous voulez afficher sur votre profile [quand vous passez votre souris sur l'image](https://i.imgur.com/KnGFdpX.
+
+```json
+"advanced-status-custom": {
+    "onJoinServer": {
+      "enable": true,
+      "message": "En jeu."
+    },
+    "onQuitServer": {
+      "enable": true,
+      "message": "Dans le menu principal."
+    },
+    "inPauseMenu": {
+      "enable": true,
+      "message": "Dans le menu pause."
+    },
+    "inMainMenu": {
+      "enable": true,
+      "message": "Dans le menu principal."
+    },
+    "inInventory": {
+      "enable": false,
+      "message": "Dans l'inventaire."
+    }
+  }
+```
+
+Cette partie va servir à afficher des informations complémentaires sur votre profile Discord. Comme [ça](https://i.imgur.com/xHJeZ39.png) par exemple.
+On retrouve plusieurs "blocs":
+- ``onJoinServer`` : Quand le joueur rejoint un serveur.
+- ``onQuitServer`` : Quand le joueur quitte un serveur. (Risque d'être supprimé car même utilité que ``inMainMenu``).
+- ``inPauseMenu`` : Quand le joueur ouvre le menu pause (ESC).
+- ``inMainMenu`` : Quand le joueur est dans le menu principal (Lancement du jeu)
+- ``inInventory`` : Quand le joueur ouvre son inventaire.
+
+Vous pourrez voir un variable ``enable`` dans chaque "bloc", cette dernière sert à activer ou nous le "bloc" en question.
+
+Si vous avez un soucis venez me voir sur Discord -> ``M4TH1EU#0001``

-|                |Valeur par défault             |Explication                  | Image |
-|----------------|-------------------------------|-----------------------------|--------|
-|`advancedstatus`  |`true`               |Ici laissez "true" si vous voulez un status avnacé sinon mettez "false".|[lien](https://imgur.com/8E0tvVu)|
-|`applicationID`   |`012345678912345678` |  Ici mettez le client id de votre application            |[lien](https://imgur.com/q2pgQZh)|
-|`largeimage`      |`logo`               | Ici mettez le nom de votre image (celle dans [RichPresence -> Art Assets](https://i.imgur.com/QHc6h8b.png))|[lien](https://imgur.com/8E0tvVu)|
-|`largeimagetext`  |`Mon serveur`        | Ici mettez le texte qui s'affichera quand vous passerez la souris sur l'image.| [lien](https://imgur.com/GgSFMZC)|