Documentation

# 📚 RĂšglement de l'Ă©vĂ©nement

# 📝 Introduction

Le systÚme de rÚgles d'événement permet de créer un livre personnalisé contenant les rÚgles de votre serveur ou événement. Les joueurs peuvent consulter ce livre en utilisant la commande /rules (ou /eventrules, /regles).

# ⚙️ Configuration

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

# Structure de Base

event-rules:
  enabled: true
  book-title: "&6&lRĂšgles de l'ÉvĂ©nement"
  book-author: "Administration"
  pages:
    - "&l&6RĂšgles de l'ÉvĂ©nement\n\n&r&7Bienvenue !"
    - "&l&cRĂšgle 1: Respect\n\n&r&7Respectez tous les joueurs."

# 🔧 ParamĂštres

# enabled

  • Type: Boolean
  • DĂ©faut: true
  • Description: Active ou dĂ©sactive le systĂšme de rĂšgles d'Ă©vĂ©nement.

Comportement:

  • true: Les joueurs peuvent utiliser /rules pour voir le livre des rĂšgles
  • false: La commande /rules affiche un message indiquant que les rĂšgles ne sont pas disponibles

Exemple:

event-rules:
  enabled: true

# book-title

  • Type: String
  • DĂ©faut: "&6&lRĂšgles de l'ÉvĂ©nement"
  • Description: Le titre du livre affichĂ© dans l'inventaire.

Limitations:

  • Maximum 32 caractĂšres (limite Minecraft)
  • Si le titre dĂ©passe 32 caractĂšres, il sera automatiquement tronquĂ© avec "..."
  • Les codes couleur comptent dans la limite de caractĂšres

Exemple:

event-rules:
  book-title: "&6&lRĂšgles du Serveur"

# book-author

  • Type: String
  • DĂ©faut: "Administration"
  • Description: L'auteur du livre affichĂ© dans les mĂ©tadonnĂ©es.

Exemple:

event-rules:
  book-author: "Équipe de ModĂ©ration"

# pages

  • Description: Liste des pages du livre. Chaque Ă©lĂ©ment de la liste reprĂ©sente une page.

Limitations importantes:

  • Maximum ~256 caractĂšres par page (limite Minecraft)
  • Maximum 14 lignes par page (limite Minecraft)
  • Si une page dĂ©passe 256 caractĂšres, elle sera automatiquement tronquĂ©e avec "..."
  • Utilisez \n pour crĂ©er des retours Ă  la ligne dans une page

Pages par défaut: Si aucune configuration n'est fournie, le systÚme utilise ces pages par défaut :

pages:
  - "&l&6RĂšgles de l'ÉvĂ©nement\n\n&r&7Bienvenue !\n\n&r&fVeuillez lire attentivement les rĂšgles suivantes."
  - "&l&cRÚgle 1: Respect\n\n&r&7Respectez tous les joueurs et l'équipe de modération.\n\n&r&fAucun comportement toxique ne sera toléré."
  - "&l&6Merci !\n\n&r&7En suivant ces rÚgles, vous contribuez à créer une expérience agréable pour tous."

# 🎨 Codes Couleur

Vous pouvez utiliser les codes couleur Minecraft standard dans les pages :

  • &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)

Note: Les codes couleur & sont automatiquement convertis en codes § pour les livres Minecraft.

# 📋 Exemples de Configuration

# Exemple 1 : RĂšgles Simples

Un livre avec quelques rĂšgles de base.

event-rules:
  enabled: true
  book-title: "&6&lRĂšgles du Serveur"
  book-author: "Administration"
  pages:
    - "&l&6RĂšgles du Serveur\n\n&r&7Bienvenue sur le serveur !\n\n&r&fVeuillez lire attentivement les rĂšgles suivantes."
    - "&l&cRÚgle 1: Respect\n\n&r&7Respectez tous les joueurs et l'équipe de modération.\n\n&r&fAucun comportement toxique ne sera toléré."
    - "&l&cRÚgle 2: Triche\n\n&r&7L'utilisation de cheats, hacks ou mods non autorisés est strictement interdite.\n\n&r&fLes contrevenants seront bannis."
    - "&l&aMerci !\n\n&r&7En suivant ces rÚgles, vous contribuez à créer une expérience agréable pour tous."

# Exemple 2 : RÚgles Détaillées

Un livre plus complet avec plusieurs pages de rĂšgles.

event-rules:
  enabled: true
  book-title: "&6&lRĂšgles de l'ÉvĂ©nement"
  book-author: "Équipe de ModĂ©ration"
  pages:
    - "&l&6RĂšgles de l'ÉvĂ©nement\n\n&r&7Bienvenue !\n\n&r&fVeuillez lire attentivement les rĂšgles suivantes pour participer Ă  l'Ă©vĂ©nement."
    - "&l&cRÚgle 1: Respect\n\n&r&7Respectez tous les joueurs et l'équipe de modération.\n\n&r&fAucun comportement toxique ne sera toléré."
    - "&l&cRÚgle 2: Triche\n\n&r&7L'utilisation de cheats, hacks ou mods non autorisés est strictement interdite.\n\n&r&fLes contrevenants seront bannis."
    - "&l&cRĂšgle 3: Équipe\n\n&r&7Travaillez en Ă©quipe et communiquez efficacement.\n\n&r&fLa coopĂ©ration est essentielle pour rĂ©ussir."
    - "&l&6Bonnes Pratiques\n\n&r&7- Écoutez les instructions des modĂ©rateurs\n- Signalez tout comportement suspect\n- Profitez de l'Ă©vĂ©nement !"
    - "&l&aMerci !\n\n&r&7En suivant ces rÚgles, vous contribuez à créer une expérience agréable pour tous.\n\n&r&f&lBon jeu !"

# Exemple 3 : Formatage Avancé

Un livre utilisant différents styles de formatage.

event-rules:
  enabled: true
  book-title: "&5&lGuide du Joueur"
  book-author: "Staff"
  pages:
    - "&l&5&m═══════════════\n&r&5&lGuide du Joueur\n&l&5&m═══════════════\n\n&r&7Bienvenue !\n\n&r&fCe guide contient toutes les informations importantes."
    - "&l&e&nCommandes Utiles:\n\n&r&a/spawn &7- Retourner au spawn\n&a/warp &7- Se téléporter\n&a/team &7- Gestion d'équipe\n&a/challenge &7- Défis"
    - "&l&c&nRĂšgles Importantes:\n\n&r&4&l1. &r&7Respectez les autres\n&4&l2. &r&7Pas de triche\n&4&l3. &r&7Pas de spam"
    - "&l&a&nConseils:\n\n&r&7- Rejoignez une équipe\n- Participez aux événements\n- Amusez-vous !"

# Exemple 4 : RĂšgles d'ÉvĂ©nement Temporaire

Un livre pour un événement spécifique avec des rÚgles temporaires.

event-rules:
  enabled: true
  book-title: "&c&lÉvĂ©nement SpĂ©cial"
  book-author: "ÉvĂ©nements"
  pages:
    - "&l&c&m═══════════════\n&r&c&lÉVÉNEMENT SPÉCIAL\n&l&c&m═══════════════\n\n&r&7Dates: 1er - 7 Janvier\n\n&r&fLisez les rùgles ci-dessous."
    - "&l&eRĂšgles de l'ÉvĂ©nement:\n\n&r&7- DurĂ©e limitĂ©e: 7 jours\n- Équipes de 4 joueurs max\n- Pas de respawn pendant l'Ă©vĂ©nement"
    - "&l&aRécompenses:\n\n&r&7- 1er place: 1000 émeraudes\n- 2Úme place: 500 émeraudes\n- 3Úme place: 250 émeraudes"
    - "&l&6Bon jeu !\n\n&r&7Amusez-vous et respectez les rĂšgles."

# 🎮 Utilisation In-Game

Les joueurs peuvent utiliser les commandes suivantes pour ouvrir le livre des rĂšgles :

  • /rules - Commande principale
  • /eventrules - Alias
  • /regles - Alias (français)

# 🔄 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.

# 📝 Notes Importantes

# Limites des Livres Minecraft

Les livres Minecraft ont des limitations strictes :

  1. CaractĂšres par page: Maximum ~256 caractĂšres par page
    • Si une page dĂ©passe cette limite, elle sera automatiquement tronquĂ©e
    • Les codes couleur comptent dans cette limite
  2. Lignes par page: Maximum 14 lignes par page
    • Les lignes sont comptĂ©es aprĂšs le formatage
    • Utilisez \n pour crĂ©er des retours Ă  la ligne
  3. Titre du livre: Maximum 32 caractĂšres
    • Si le titre dĂ©passe cette limite, il sera automatiquement tronquĂ© avec "..."
  4. Nombre de pages: Pas de limite stricte, mais gardez Ă  l'esprit que trop de pages peuvent ĂȘtre difficiles Ă  naviguer

# Formatage des Pages

  • Utilisez \n pour crĂ©er des retours Ă  la ligne dans une page
  • Les codes couleur & sont automatiquement convertis en codes §
  • Le code &r rĂ©initialise tous les formats (utile pour rĂ©initialiser les couleurs)

# Conseils de Formatage

  1. Utilisez des titres: &l&6Titre pour les titres de section
  2. Utilisez des sĂ©parateurs: &7&m────── pour les lignes de sĂ©paration
  3. Gardez les pages courtes: Respectez la limite de 256 caractĂšres
  4. Testez vos pages: Ouvrez le livre en jeu pour vérifier le formatage

# 🖥️ Configuration via GUI

Les rĂšgles peuvent Ă©galement ĂȘtre configurĂ©es via le GUI d'administration :

  1. Ouvrez le menu admin avec /hz gui
  2. Accédez à la section "Configuration"
  3. SĂ©lectionnez "RĂšgles d'ÉvĂ©nement"
  4. Modifiez le titre, l'auteur et les pages
  5. Sauvegardez les modifications

Note: Les modifications via le GUI sont automatiquement sauvegardées dans config.yml.

# 💡 Conseils

# Organisation des Pages

  1. Page d'introduction: Commencez par une page de bienvenue
  2. Pages de rÚgles: Organisez les rÚgles par catégories (une page par catégorie)
  3. Page de conclusion: Terminez par une page de remerciement ou de conseils

# Formatage Visuel

  1. Utilisez des couleurs différentes pour différencier les sections
  2. Utilisez des séparateurs pour améliorer la lisibilité
  3. Utilisez le formatage (&l pour gras, &n pour souligné) pour mettre en évidence

# Longueur des Pages

  1. Gardez les pages courtes pour une meilleure lisibilité
  2. Divisez le contenu en plusieurs pages si nécessaire
  3. Testez vos pages en jeu pour vérifier qu'elles s'affichent correctement