tilttek/quests-bundle

tilttek/quests-bundle intègre tilttek/quests à Symfony. Les quêtes, avec leurs étapes, leurs genres, leurs dates, leurs chaînes et leurs récompenses, sont écrites dans la configuration et vérifiées à la compilation du conteneur. Elles peuvent aussi être gardées en base de données et modifiées par l'application. Une quête qui revient à des dates calculées, comme une semaine à partir de Pâques ou les jours autour d'un solstice, est lue par phil/almanac. La progression, les acceptations des membres, le journal des quêtes accomplies et les duels sont gardés dans Doctrine DBAL. Ils occupent cinq tables que le bundle ajoute au schéma généré par l'ORM : les migrations de l'application les créent donc. La projection qui transforme l'activité des membres en progression porte l'étiquette de tilttek/activity-bundle. Celui-ci la tient à jour à chaque geste, la rattrape et la reconstruit. Une quête accomplie devient un événement du répartiteur de l'application, avec ses récompenses et les membres qui les reçoivent ; il en va de même d'un duel gagné et d'un duel expiré. Des fonctions Twig et deux gabarits affichent la liste et le détail des quêtes. Des commandes listent les quêtes, affichent celles d'un membre et font expirer les duels. Enfin, les quêtes d'un membre sont exportées et effacées avec son compte par phil/privacy-bundle.

Il s'adresse à une application Symfony qui donne à ses membres des objectifs à atteindre, seuls, en équipe, en communauté ou les uns contre les autres. La bibliothèque seule convient à une application sans Symfony.

Il exige tilttek/quests, Doctrine DBAL, le répartiteur d'événements PSR ainsi que la configuration et le conteneur de Symfony. phil/almanac, l'ORM, la console, Twig, le traducteur et phil/privacy-bundle sont facultatifs : le bundle n'enregistre ce qui les utilise que s'ils sont installés.

La conception suit celle de la bibliothèque : les dépôts implémentent ses quatre contrats, DbalCatalog son catalogue modifiable, AlmanacScheduleReader ses lecteurs de calendrier. QuestsServices relie les services, DispatchingObserver transforme en événements ce que la bibliothèque annonce, et QuestsExtension en est le côté Twig.

État

Documentation

Démarrage rapide

// config/bundles.php
Tilttek\ActivityBundle\TilttekActivityBundle::class => ['all' => true],
Tilttek\QuestsBundle\TilttekQuestsBundle::class => ['all' => true],

# config/packages/tilttek_quests.yaml
tilttek_quests:
    timezone: America/Toronto
    quests:
        first-steps:
            ordered: true
            steps: [{ code: play, verbs: ['game.played'], count: 3 }, { code: write, verbs: ['sheet.published'] }]
            rewards: [{ kind: points, code: xp, amount: 50 }]
        easter-hunt:
            recurs: { from: 'easter - 2 days', until: 'easter + 1 day' }
            steps: [{ verbs: ['egg.found'], count: 10 }]

#[AsEventListener]
public function __invoke(QuestCompleted $event): void
{
    foreach ($event->beneficiaries as $member) {
        foreach ($event->rewards() as $reward) {
            // give the reward through the packages the application has
        }
    }
}

Prérequis

PHP 8.5 ou plus récent, Symfony 8.2 et Doctrine DBAL 4.5.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. Consultez LICENSE.