Antone Barbaud f92f22f6c8 feat: MessagesService — externalized YAML messages in a single per-plugin file
New module fr.luc.crcore.message exposing:
- MessagesService (interface) with get(key, placeholderPairs...), raw, has,
  set, reload, loadAdditional, color-code toggle.
- YamlMessagesService (impl) that auto-orchestrates everything at construction:
  1. Loads CR-Core defaults from the bundled crcore-messages.yml resource
     (always in memory as fallback for missing keys).
  2. Creates <dataFolder>/<plugin-name-lowercase>-messages.yml at first run
     by copying the plugin's own resource of the same name if it ships one,
     else CR-Core's defaults.
  3. Loads the user file as an override layer on top of the defaults.

Single per-plugin file: the admin only edits one YAML, named after the host
plugin (e.g. mygame-messages.yml). Missing keys transparently fall back to
the bundled CR-Core defaults, so future CR-Core releases adding new keys
work without forcing the admin to edit anything. Plugins can ship their
own version of the file with extra keys + overrides to seed the template.

Placeholder substitution: {name} style via varargs key/value pairs. Color
codes (&a, &c, ...) translated automatically via
ChatColor.translateAlternateColorCodes.

Migration: all 14 default /core team subcommands (create, delete, add,
remove, join, leave, info, list, transfer, setleader, visibility, score,
top, setspawn) now use messages.get(...) instead of hardcoded French
strings. CoreCommand overrides handleResult to render
SUCCESS/FAILURE/INVALID_USAGE/NO_PERMISSION/PLAYER_ONLY through the
service.

CRCore exposes the service via core.messages() / getMessages(); built via
buildMessagesService() (overridable for custom impl).

Bundled defaults: src/main/resources/crcore-messages.yml with the full set
of French defaults, documented inline (placeholders listed per message).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-09 15:58:02 +02:00

Documentation CR-Core

Ce dossier est la source de vérité du projet. Toutes les décisions, idées, mécaniques, règles et spécifications du noyau sont consignées ici.

Objectif du projet

CR-Core est une librairie Maven réutilisable pour construire des plugins Minecraft Paper 1.16.5. Elle fournit, prêt à l'emploi en une ligne d'initialisation côté plugin de jeu :

  • Abstractions communesIdentifiable, Named, ScoreHolder, AbstractEntity, Repository<T>.
  • Domaine Team — équipes (nom, tag, couleur, chef, membres, visibilité PUBLIC/PRIVATE, scores nommés, classements, point de spawn), service overridable, exceptions dédiées.
  • Domaine Player — profils joueurs (scores nommés, classements individuels), service auto-créant les profils à la demande.
  • Framework de commandesBaseCommand / SubCommand imbriqués, arguments typés, tab-complétion, permissions, player-only.
  • Commandes par défaut/core team [create|delete|add|remove|join| leave|info|list|transfer|visibility|score|top|setspawn] fonctionnelles out-of-the-box, chacune substituable par sous-classe.
  • Évènements Bukkit — 9 events team + 3 events player, à écouter avec @EventHandler côté plugin de jeu.
  • Persistance SQLite — wrapper Database + TableBuilder fluide, repositories SQLite write-through, table custom en 2 lignes pour les plugins downstream.
  • Bootstrap uniquenew CRCore(this).enable() dans le onEnable() du plugin de jeu, et tout est branché.

Structure de la documentation

  • README.md — Ce fichier. Vue d'ensemble et index.
  • setup.md — Build, intégration dans un plugin de jeu, exemple d'usage.
  • features.md — Domaines fonctionnels détaillés.
  • decisions.md — Journal des décisions importantes (ADR léger).
  • diagrams/ — Diagrammes PlantUML (.puml).

Diagrammes

Fichier Type Sujet
team-class-diagram.puml Classe Domaine Team + abstractions communes
team-create-sequence.puml Séquence Création d'une équipe via la commande
team-join-sequence.puml Séquence Auto-join sur une équipe publique
team-create-activity.puml Activité Flux de validation à la création
player-class-diagram.puml Classe Domaine Player + scores joueur
command-class-diagram.puml Classe Framework de commandes (nested)
builtin-commands-diagram.puml Classe Arbre des commandes /core team ...
events-diagram.puml Classe Évènements Bukkit team + player
database-diagram.puml Classe Wrapper SQLite + table builder
bootstrap-sequence.puml Séquence CRCore.enable() côté plugin de jeu

Conventions

  • Code : anglais standard, séparation stricte interfaces / enums / classes abstraites / classes concrètes / exceptions.
  • Doc & messages joueur : français.
  • JavaDoc en français sur les classes publiques et méthodes non triviales.
  • Package racine : fr.luc.crcore.
  • Classes du noyau non-final, méthodes-clés protected, hooks onBefore…/onAfter… et factories new… pour l'override.

Contribuer à la doc

Chaque nouvelle idée, règle, commande ou contrainte discutée doit être ajoutée au fichier approprié, avant ou pendant l'implémentation. La doc précède le code.

S
Description
No description provided
Readme 767 KiB
Languages
Java 100%