Documentation

# 💡 /Help personnalisé

# 📝 Introduction

Le système de help personnalisé permet de remplacer le help par défaut de Minecraft (/help) par un help personnalisé pour les joueurs non-admin. Les joueurs avec les permissions admin/staff voient toujours le help par défaut de Minecraft, tandis que les autres joueurs voient votre help personnalisé.

# ⚙️ Configuration

La configuration se fait dans le fichier plugins/Horizons/config.yml sous la section custom-help.

# Structure de Base

custom-help:
  enabled: true
  messages:
    - "&7&m--------------------"
    - "&6&lAide du Serveur"
    - "&7&m--------------------"
    - "&e/help &7- Affiche cette aide"
    - "&e/spawn &7- Retourner au spawn"

# 🔧 Paramètres

# enabled

  • Type: Boolean
  • Défaut: true
  • Description: Active ou désactive le système de help personnalisé.

Comportement:

  • true: Les joueurs non-admin voient le help personnalisé
  • false: Tous les joueurs voient le help par défaut de Minecraft

Exemple:

custom-help:
  enabled: true

# messages

  • Description: Liste des messages à afficher aux joueurs lorsqu'ils utilisent /help.

Format:

  • Chaque élément de la liste est une ligne du help
  • Vous pouvez utiliser des codes couleur avec &
  • Utilisez \n pour les retours à la ligne (dans une même ligne de configuration)

Messages par défaut: Si aucune configuration n'est fournie, le système utilise ces messages par défaut :

messages:
  - "&7&m--------------------"
  - "&6&lAide du Serveur"
  - "&7&m--------------------"
  - "&e/help &7- Affiche cette aide"
  - "&e/spawn &7- Retourner au spawn"
  - "&e/team &7- Gestion de votre équipe"
  - "&7&m--------------------"

# 🎨 Placeholders Disponibles

# Placeholders de Joueur

  • {player} - Nom du joueur qui exécute la commande

Exemple:

messages:
  - "&7Bienvenue, &e{player}&7 !"

# Caractères Spéciaux

  • \n - Retour à la ligne (dans une même ligne de configuration)
  • & - Codes couleur Minecraft (voir section Codes Couleur)

# 🎨 Codes Couleur

Vous pouvez utiliser les codes couleur Minecraft standard :

  • &0 - Noir
  • &1 - Bleu foncé
  • &2 - Vert foncé
  • &3 - Cyan
  • &4 - Rouge foncé
  • &5 - Violet
  • &6 - Orange
  • &7 - Gris
  • &8 - Gris foncé
  • &9 - Bleu
  • &a - Vert
  • &b - Cyan clair
  • &c - Rouge
  • &d - Rose
  • &e - Jaune
  • &f - Blanc
  • &l - Gras
  • &m - Barré
  • &n - Souligné
  • &o - Italique
  • &r - Réinitialiser
  • &k - Texte magique (obfuscated)

# 👥 Permissions

# Joueurs Non-Admin

Les joueurs sans la permission horizons.staff et qui ne sont pas OP voient le help personnalisé lorsqu'ils utilisent /help.

# Joueurs Admin/Staff

Les joueurs avec la permission horizons.staff ou qui sont OP voient le help par défaut de Minecraft lorsqu'ils utilisent /help.

# Console et Command Blocks

La console et les command blocks voient toujours le help par défaut de Minecraft.

# 📋 Exemples de Configuration

# Exemple 1 : Help Simple

Un help basique avec les commandes principales.

custom-help:
  enabled: true
  messages:
    - "&7&m--------------------"
    - "&6&lAide du Serveur"
    - "&7&m--------------------"
    - "&e/help &7- Affiche cette aide"
    - "&e/spawn &7- Retourner au spawn"
    - "&e/team &7- Gestion de votre équipe"
    - "&e/challenge &7- Voir les défis"
    - "&7&m--------------------"

# Exemple 2 : Help Détaillé avec Placeholders

Un help plus détaillé utilisant les placeholders.

custom-help:
  enabled: true
  messages:
    - "&7&m════════════════════════════"
    - "&6&l  BIENVENUE, {player} !"
    - "&7&m════════════════════════════"
    - ""
    - "&e&lCommandes Principales:"
    - "&e/spawn &7- Retourner au spawn"
    - "&e/warp <nom> &7- Se téléporter à un warp"
    - "&e/team &7- Gestion de votre équipe"
    - ""
    - "&e&lCommunication:"
    - "&e/t <message> &7- Chat d'équipe"
    - "&e/whisper <joueur> <message> &7- Message privé"
    - "&e/report <joueur> <raison> &7- Signaler un joueur"
    - ""
    - "&e&lDéfis:"
    - "&e/challenge &7- Voir vos défis"
    - "&e/challenge progress &7- Voir votre progression"
    - ""
    - "&7&m════════════════════════════"

# Exemple 3 : Help avec Retours à la Ligne

Un help utilisant des retours à la ligne pour un meilleur formatage.

custom-help:
  enabled: true
  messages:
    - "&6&l╔════════════════════════╗"
    - "&6&l║  &f&lAIDE DU SERVEUR  &6&l║"
    - "&6&l╚════════════════════════╝"
    - ""
    - "&e&lCommandes Disponibles:\n&7Utilisez ces commandes pour naviguer sur le serveur."
    - ""
    - "&a/spawn &7- Retourner au spawn"
    - "&a/warp &7- Se téléporter"
    - "&a/team &7- Gestion d'équipe"
    - "&a/challenge &7- Défis disponibles"
    - ""
    - "&7Pour plus d'informations, contactez un modérateur."

# Exemple 4 : Help Minimaliste

Un help simple et épuré.

custom-help:
  enabled: true
  messages:
    - "&6&lAide"
    - "&e/spawn &7- Spawn"
    - "&e/team &7- Équipe"
    - "&e/challenge &7- Défis"

# 🔄 Rechargement

Pour appliquer les modifications de configuration :

  1. Via commande: Utilisez /horizons reload ou /hz reload
  2. Redémarrage: Redémarrez le serveur

Note: Après modification du fichier config.yml, vous devez recharger la configuration pour que les changements prennent effet.