Le guide complet d’Essentials

En voilà un projet totalement fou, réaliser une documentation complète d’Essentials en expliquant toutes les fonctionnalités de ce plugin. Oui, vous le savez maintenant, chez Minecraft-France, nous sommes exploités, durement, sauvagement, mais c’est pour votre bien… du moins je l’espère.

Essentials n’est pas qu’un plugin, mais est décomposé en 5 plugins distincts:

1. Essentials, celui par défaut
2. Essentials Anti-Build
3. Essentials Protect
4. Essentials Chat
5. Essentials Spawn

Vous l’aviez peut être remarqué lorsque vous avez installé ce plugin sur votre serveur. Il y a, dans le .zip d’Essentials, 5 plugins à installer dans votre dossier /plugins.

Vous n’êtes pas sans savoir qu’avant de vous lancer dans la configuration et la compréhension d’un plugin, vous devez au préalable avoir quelques notions de code (ou au moins savoir « bidouiller » dans un fichier de configuration) et avoir un serveur Minecraft disponible afin de pouvoir accueillir le plugin Essentials.

Je vous recommande également l’utilisation d’un éditeur de texte. Prenez celui qui vous convient. Personnellement, pour ce tutoriel, j’utiliserai Atom, un nouvel éditeur opensource développé par des passionnés.

Sommaire:

1. Installer Essentials sur un serveur
2. Connaître les bases d’Essentials
3. Configurer les messages d’Essentials
   1. Activer ou désactiver les messages de morts
   2. Les messages de connexion et de déconnexion
   3. Modifier le message a chaque connexion (les informations)
   4. Configurer la première connexion de vos joueurs
4. Créer des kits pour vos joueurs avec Essentials
5. Configurer la téléportation
6. Modifier les pseudos avec les nicknames
7. Configurer les homes des joueurs avec EssentialsHome
8. Gérer l’économie d’un serveur avec EssentialsEco
9. Configurer le statut des joueurs (AFK)
   1. Période d’inactivité
   2. Éjecter un joueur
   3. Protéger un joueur
   4. Récupérer les drops
   5. Interaction
   6. Se déplacer
10. Les diverses autres options d’Essentials
    1. Gérer le temps (weather = météo)
    2. Gérer le spawn des mobs
    3. Supprimer des commandes
    4. Réparation d’items enchantés
    5. Interaction avec les panneaux
    6. Modifier les dégâts subis

Installer Essentials sur un serveur

Vous devez, au préalable, télécharger Essentials en fonction de la version où vous êtes. Pour cette documentation, nous allons installer Essentials en 1.9 sous Spigot.

Essentials 1.9 sous Spigot

A partir du Jenkins de Spigot-Essentials, j’ai constitué un dossier réunissant toutes les snapshots.

 Après téléchargement effectué, déposez ces 5 plugins dans le dossier /plugins de votre serveur. Après un redémarrage ou un reload (le redémarrage est conseillé), vous devrez avoir ceci en tapant /plugins dans votre console serveur.

Si les noms des plugins sont en vert, tout fonctionne : vos plugins sont fonctionnels et prêts à l’emploi. Si certains sont en rouge ou que certains n’apparaissent pas dans la liste, il y a alors un problème de version (très probablement, ou un litige -> vérifiez les logs). Ne faites pas attention au plugin WorldEdit, celui-ci était déjà installé et n’est pas dans le dossier de téléchargement.

Connaître les bases d’Essentials

Avant toute chose, il faut connaître quelques termes qui seront très important pour la configuration du plugin, et connaître également quelques normes d’écriture.

• L’option « true » veut dire « activé« 
• L’option « false » veut dire « désactivé« 

Sachez également que dans tout code et que dans tout langage, on peut commenter des lignes qui ne sont pas visibles sur le site mais qui ne le sont que dans les fichiers, elles ne sont donc pas prise en compte par le plugin. En .yml, on commente des lignes avec un # avant une phrase.

Le code couleur est aussi très important dans Essentials. Défini comme suit « §valeur hexadécimal« , ce code couleur vous permet alors d’enjoliver vos textes et d’y attribuer des couleurs, ou du code de mise en forme tels que le gras, l’italique, le souligné et le surligné.

Voici donc, en plus des codes couleur, les codes de mise en forme, afin d’attribuer encore plus de propriété a vos textes. Vous pouvez utiliser la couleur et la mise en forme en même temps sur un même mot ou une même phrase.

Par la suite, en utilisant ces codes, on peut arriver à faire ce genre de chose:

Le code couleur doit obligatoirement être avant le code de format. Par exemple, si je veux mettre « Minecraft-France » en gras et en bleu clair, je dois faire comme suit : « &9&lMinecraft-France ». Si vous ne mettez pas &r après, le texte qui suivra prendra la couleur et le format « &9&l ».

Après avoir expliqué la base, nous allons pouvoir configurer proprement le config.yml d’Essentials. Votre dossier Essentials dans /plugins doit ressembler à celui-ci :

Ouvrez le fichier « config.yml ». C’est ce fichier où se trouve l’intégralité de la configuration des 5 plugins que nous avons installé au tout début de ce guide.

Vous vous en souvenez, nous avons installé 5 plugins : Essentials, Anti-Build, Protect, Chat et Spawn. Vous avez pu le remarquer, votre fichier de configuration est également découpé en 8 parties:

1. Essentials (Global)
2. EssentialsHome
3. EssentialsEco
4. EssentialsHelp
5. EssentialsChat
6. EssentialsProtect
7. EssentialsAntiBuild
8. Essentials Spawn / New Players

Ce découpage est effectué via des blocs de commentaire comme ci-dessous, et cela pour les 8 parties.

Par défaut, Essentials est en anglais, mais vous pouvez attribuer une autre langue au plugin. En ajoutant « fr », l’intégralité de votre plugin et de vos messages seront en français.

Configurer les messages d’Essentials

Essentials vous permet d’effectuer beaucoup de modifications de messages. Voici une liste de ce qu’Essentials permet de faire :

• Activer ou désactiver les messages de morts
• Permettre ou non de cacher les messages de connexion/déconnexion
• Modifier les messages de connexion/déconnexion
• Modifier le message de bienvenue (première connexion d’un joueur)
• Modifier le message d’information dès la connexion

Activer ou désactiver les messages de morts

Ouvrez le fichier config.yml et cherchez la ligne 361 ou faites CTRL + F et tapez « death-message« .

death-messages: true

1. En mettant « true« , les messages de morts sont activés et visibles par tout le serveur.
2. En mettant « false« , les messages de morts sont désactivés et non-visibles.

Les messages de connexion et de déconnexion

En vous rendant à la ligne 366 (ou CTRL + F  : « allow-silent-join-quit« ), vous pourrez ou non désactiver l’affichage des messages de connexion ou de déconnexion.

1. En mettant « true« , les messages de connexion/déconnexion sont activés et visibles.
2. En mettant « false« , les messages de connexion/déconnexion sont désactivés et non-visibles.

Par défaut, les messages sont les suivants :

1. Message de connexion: « … joined the game »
2. Message de déconnexion: « … left the game »

Si vous souhaitez les modifier, cherchez la ligne 370 et la ligne 374.

custom-join-message: « none »
custom-quit-message: « none »

Maintenant, il faut faire la distinction entre :

• {USERNAME} : il prendra uniquement votre pseudo.
• {PLAYER} : il prendra votre pseudo ainsi que la couleur de votre grade actuel, avec les préfixes et les suffixes de groupes (si vous en avez).

En plus des couleurs, vous pouvez également ajouter les codes de mise en forme (cf: le tableau plus haut regroupant toutes les mises en forme disponible).

Configurer la première connexion de vos joueurs

Essentials vous permet également de modifier le message de bienvenue. Celui-ci apparait lorsqu’un joueur se connecte pour la toute première fois sur le serveur. On a également un kit par défaut, nous permettant de pouvoir survivre et jouer plus facilement. Par défaut :

Mais on va modifier ça pour que ça soit plus joli, et que le kit soit plus fun.

Je ne vais pas vous expliquer comment modifier, vous avez dû comprendre maintenant. Maintenant, on va configurer le kit de départ, si vous en voulez un bien évidemment.

Nous venons de créer le kit « débutant ». Personnellement, je ne me suis pas embêté, j’ai renommé le kit « tool » par défaut. Dans « items« , vous ajoutez les items que vous voulez, et ils apparaitront dans l’inventaire des nouveaux.

• 272 est l’ID de l’item
• 1 est la quantité d’item distribué

Modifier le message d’information dès la connexion

Essentials envoie un message avec des informations sur votre compte et sur le serveur à chaque fois que vous vous connectez sur le serveur. Par défaut, le message est celui-ci :

Mais vous pouvez le modifier via le fichier motd.txt présent dans le dossier /Essentials.

Ouvrez le fichier, et vous aurez donc ceci dans le .txt :

Vous disposez de plusieurs balises permettant de personnaliser le motd :

1. {USERNAME} : afficher le pseudo du joueur
2. {PLAYERLIST} : afficher les joueurs connectés
3. {BALANCE} : afficher le compte en banque
4. {IP} : afficher l’ip du joueur
5. {MAILS} : afficher les mails non-lus
6. {ONLINE} : affiche le nombre de joueurs connectés
7. {DATE} : affiche la date
8. {TIME} : affiche l’heure
9. {WORLD} : affiche le nom du monde dans lequel le joueur est
10. {PLUGINS} : affiche les plugins installés

Créer des kits pour vos joueurs avec Essentials

Nous l’avons vu plus haut, nous pouvons paramétrer des kits disponibles pour les débutants mais également pour des arènes par exemple, ou pour tout autre chose, tout dépend de ce que vous voulez en faire. Ainsi, nous allons détailler les possibilités des kits que proposent Essentials à travers un tableau.

Configurer le Chat avec Essentials

Nous pouvons, à partir d’Essentials, changer la configuration et l’apparition des messages. A la ligne 532, on croise alors plusieurs balises. Nous allons les définir :

• {MESSAGE} : balise permettant d’afficher le message.
• {DISPLAYNAME} : balise permettant d’afficher le joueur qui envoie le message.
• {WORLDNAME} : balise avec MultiverseCore permettant d’afficher le nom dans lequel vous vous situez.
• {SHORTWORLDNAME} : balise du même type de celle précédente mais permettant de réduire le nom du monde en affichant uniquement les 3 premières lettres de ce monde.
• {GROUP} : balise permettant d’afficher le groupe auquel appartient le joueur.

Voici un exemple de message que l’on peut avoir :

Mon pseudo est en rouge puisque je suis /op. La balise {DISPLAYNAME} prend également en compte le groupe auquel appartient le joueur.

De ce fait, si vous souhaitez supprimer le préfixe du monde dans lequel vous vous trouvez, vous devez ouvrir (en plus d’avoir modifié le format dans Essentials) la config.yml :

Sauvegardez le fichier et faites un /mv reload pour recharger le plugin et prendre en compte les modifications effectuées dans le fichier de configuration.

Essentials vous permet une autre option avec les messages. Vous pouvez configurer les messages de manière à ce que les messages soient lus en fonction d’un radius prédéfini dans le fichier de configuration. Pour être plus clair, si on configure le radius 5 dans la config.yml, seuls les joueurs avec un radius de 5 blocs autour de vous pourront lire vos messages.

1. essentials.chat.shout : cette permission permettra aux joueurs (tout dépend a qui vous attribuez la permission) d’envoyer des messages précédés d’un point d’exclamation et ces messages seront lu par tout le monde, peu importe le rayon des joueurs.
2. essentials.chat.question : précédé d’un point d’interrogation, le message sera vu par tous les joueurs, peu importe le rayon.
3. essentials.chat.spy : les joueurs ayant cette permission pourront lire tous les messages envoyés, peu importe le rayon des joueurs.

Cette option se trouve à la ligne 526 du fichier de configuration d’Essentials.

Configurer la téléportation avec Essentials

Avec l’option « teleport-cooldown« , vous pouvez paramétrer, en secondes, le temps d’attente ENTRE chaque téléportation de type /home, /tp ou /warp. Le message ci-dessous apparaît après avoir effectué une téléportation, et vous demande d’attendre 10 secondes pour pouvoir effectuer une nouvelle fois la commande.

Avec l’option « teleport-delay« , vous pouvez configurer le temps d’attente pour une téléportation. Le message ci-dessous apparaît dès le premier envoie d’une commande de téléportation, comme /home par exemple. Vous devez obligatoirement attendre 20 secondes pour être téléporté.

Voici le fichier de configuration que j’ai modifié. Sachez que l’option « teleport-safety » vous permet de vous téléporter en toute sécurité. Si il y a de la lave ou un vide a côté de là où vous souhaitez vous téléporter, le serveur vous téléportera dans un endroit sécurisé.

Essentials est gentil avec ses utilisateurs, et pense à tout. Il vous permet d’avoir de l’invulnérabilité pendant un certain temps via l’option « teleport-invulnerability« , exprimé en seconde, à la ligne 57. Vous pouvez modifier comme bon vous semble. Mettez 0 si vous ne souhaitez pas avoir de vulnérabilité.

Modifier les pseudos avec les nicknames

Le nickname permet de renommer un joueur avec la commande /nick [pseudo] [nouveau]. Je vais vous montrer la configuration que j’ai réalisé pour pouvoir arriver à ce résultat :

Ce que j’ai modifié pour pouvoir en arriver jusqu’à là :

• Ligne 532 : le format du chat via Essentials Chat. J’ai modifié donc le format, ajouté « < » et « > » en début et fin du pseudo avec la couleur blanche (&f)

• Ligne 23 : la couleur des joueurs op. Pour l’exemple, j’ai ajouté la couleur &e. Vous pouvez également ne rien mettre et configurer les couleurs via le format ou groups-format à la ligne 523.

• Ligne 26 : le préfixe du nickname. Par défaut, lorsqu’un joueur est renommé, ceci « ~ » est devant son pseudo afin de savoir qu’il a été renommé. J’ai supprimé ce caractère.

Vous pouvez également configurer le nombre maximum de caractère dans un nickname à la ligne 29 via l’option « max-nick-length: 15« .

Par défaut commenté, cette ligne permet de mettre à jour la tablist avec les nouveaux pseudos des joueurs qui ont été renommés. Pratique pour ne pas se perdre dans les modifications des pseudos.

Configurer les homes des joueurs

Comme vous le savez déjà tous, vous pouvez set un home en faisant un clic droit sur un lit, de jour comme de nuit, le set fonctionnera toujours. EssentialsHome vous permet de modifier ce paramètre. A la ligne 432, l’option « update-bed-at-daytime » vous permet d’activer ou de désactiver le fait que les joueurs puissent effectuer un sethome de jour dans leur lit.

1. « true » : activer
2. « false » : désactiver

L’option « sethome-multiple » permet à certains groupes de pouvoir avoir plusieurs home disponible. Ils peuvent donc effectuer plusieurs /sethome à la limite de ce que vous avez configuré. Voici la configuration par défaut d’EssentialsHome :

Ainsi, cette configuration signifie que :

1. Les joueurs normaux « default » peuvent créer 3 homes.
2. Les VIP « vip » peuvent créer 5 homes.
3. Les membres du staff « staff » peuvent créer 10 homes.

• Pour la permission du groupe « default » ayant 3 homes, vous devez donc attribuer au groupe Joueur la permission suivante : essentials.sethome.multiple.default
• Pour la permission du groupe « vip » ayant 5 homes, vous devez donc attribuer au groupe VIP la permission suivante : essentials.sethome.multiple.vip
• Pour la permission du groupe « staff » ayant 10 homes, vous devez donc attribuer au groupe Staff la permission suivante : essentials.sethome.multiple.staff

Gérer l’économie d’un serveur avec EssentialsEco

Avec le plugin EssentialsEco, tous les joueurs d’un serveur disposeront d’un compte en banque. au début, celui-ci est vide et ne contient aucun argent. L’objectif d’EssentialsEco est d’ainsi pouvoir vendre et effectuer des échanges avec les membres.

Afin de modifier le compte en banque d’un joueur qui arrive pour la première fois sur le serveur, vous devez modifier la ligne 467 et changer la valeur de l’option « starting-balance« .

Par défaut, le symbole de votre monnaie est le dollar.

Vous pouvez changer ce symbole en allant à la ligne 483. Pour ma part, j’ai attribué la valeur sur € mais vous pouvez mettre n’importe quel autre symbole.

D’autres paramètres peuvent aussi être modifiés pour améliorer l’économie du serveur :

• Ligne 487 : le nombre maximum d’argent possible sur un compte
  • par défaut: max-money: 10000000000000
• Ligne 491 : le nombre minimum d’argent possible sur un compte (déficit ou non)
  • par défaut : min-money: -10000
  • seuls les joueurs ayant la permission « essentials.eco.loan«  peuvent dépenser même en ayant un déficit (jusqu’à la limite)
• Ligne 494 : archiver ou non les échanges et achats
  • par défaut : economy-log-enabled: false

Configurer le statut des joueurs

Le statut des joueurs, c’est en réalité la fonction « AFK » que propose Essentials, et ils proposent beaucoup d’options permettant ainsi de correctement personnaliser cette fonction. On fera ça sous forme de tableau également, car c’est toujours plus facile !

• Période d’inactivité 
• Éjecter un joueur 
• Protéger les joueurs 
• Récupérer les drops
• Interaction
• Se déplacer

Un joueur est automatiquement mis en mode « AFK »  au bout d’un certain temps. Par défaut, Essentials défini le délai avant d’être AFK à partir de 300 secondes (5 minutes). Vous pouvez modifier cela via l’option « auto-afk » à la ligne 333. 

Cette option permet au serveur de savoir au bout de combien de temps un joueur peut être exclu du serveur pour cause d’inactivité. Essentials règle cela avec l’option « auto-afk-kick« . De base, Essentials désactive cette option avec comme valeur « -1 » permettant alors de ne pas exclure les joueurs.Vous pouvez changer la valeur comme vous le souhaitez, mais essayez d’être en cohérence avec l’option « auto-afp« . Vous n’allez pas mettre 300 pour l’auto-afk et mettre 150 pour l’auto-afp-kick. La valeur est exprimée en secondes.

Une option permet de protéger les joueurs. En effet, celle-ci vous permet de « freeze » un joueur, c’est-à-dire que ni un joueur ni un mob peut donner des dégâts au joueur étant AFK. A la ligne 345, l’option « freeze-afk-players » vous permet donc de freeze les joueurs AFK.

Cette option permet (ou non) aux joueurs AFK de récupérer des drops (ou items) au sol. Par défaut, l’option est désactivée, mais vous pouvez l’activer à la ligne 349.

Le plugin et le serveur considère qu’un joueur n’est plus AFK a partir d’un moment où un joueur entre en interaction avec un bloc, un mod ou un joueur qui le fait bouger. L’option « cancel-afk-on-interact » à la ligne 353 permet d’activer les interactions.

Pour qu’un joueur puisse ne plus être considéré comme « AFK », il doit bouger (sauter, avancer…). L’option peut alors être désactivée via « cancel-afk-on-move » a la ligne 358.

Les diverses autres options d’Essentials

Afin de faciliter la compréhension et éviter d’avoir un guide de plus de 5000 mots, on va essayer de faire ça sous forme de tableau, ça vous permettra de comprendre facilement et d’avoir quelque chose d’encadré.

• Gérer la météo
• Spawn des mobs
• Commandes
• Réparation d’items
• Panneaux
• Dégats subis
• Le /heal et le /feed

Vous pouvez gérer le temps sur votre serveur, en désactiver l’orage, le tonnerre et l’éclair via la ligne 632 et l’option weather. Mettez « true » pour désactiver, et « false » pour activer.

La commande /spawnmob vous permet de faire apparaître des mobs à un nombre maximum de 10. Vous pouvez modifier cette valeur à la ligne 84 via l’option spawnmob-limit.

De plus, il est possible de supprimer le spawn de certains mobs avec l’option spawn de la ligne 582. Lorsqu’il y a false devant un mob, le spawn est autorisé (puisque l’option vous permet de refuser le spawn, donc false signifie que l’on ne refuse pas qu’il spawn). Si vous souhaitez refuser le spawn des zombies par exemple, ajoutez « true » devant.

disabled-commands, disponible a la ligne 106, vous permet de supprimer des commandes. Si vous supprimez des commandes, cela s’appliquera également aux administrateurs, ces commandes ne seront alors plus du tout fonctionnel sur le serveur jusqu’à ce que vous les remettez.

Vous pouvez réparer votre équipement avec la commande /repair. Celle-ci réparera alors tous les équipements abimés qui sont dans votre inventaire. Vous pouvez activer ou non cette commande, et attribuer même une permissions essentials.repair.enchanted. Vous pouvez alors laisser l’option activée et déterminer les groupes ayant accès.

Oui, vous ne rêvez pas, Essentials vous permet, en plus de toutes ces autres fonctionnalités, d’attribuer des commandes sur des panneaux.

Si vous souhaitez activer la balise « time » par exemple, vous devez obligatoirement supprimer le commentaire exprimé avec le « # » et redémarrez (ou reload) votre serveur.

Pour avoir plus d’informations sur les balises a utiliser, référez-vous sur le wiki d’Essentials.

Plus d’informations sur les panneaux

L’option sign-use-per-second contrôle le temps (en seconde) entre l’utilisation d’un panneau. Par exemple, si c’est configuré sur 4 secondes, je ne peux interagir avec le panneau « weather » que toutes les 4 secondes.

Il est possible d’activer ou non certains dégâts infligés par des « blocs », monstres ou par la météo via l’option disabled à la ligne 620. Mettez « true » pour désactiver, et « false » pour activer. 

La commande /heal et /feed permet, respectivement, de vous soigner totalement et de remplir la barre de faim au total. Si vous avez faim et que vous avez perdu de la vie, la commande /heal vous remplira les deux barres.

La ligne 60 vous permet alors de gérer le temps entre chaque commande. Le temps est exprimé en secondes. Vous pouvez désactiver la commande via « disabled-commands« , commande que l’on a vu plus haut.

Image de Une réalisée par Biboush. Merci à elle.