tilttek/collections

tilttek/collections garde ce que collectionnent les membres d'un site. Un catalogue déclare des raretés — common, rare, legendary — avec leurs poids, des objets avec un nom et une description traduits, une image, une rareté et les ensembles auxquels ils appartiennent, des ensembles qui valent leurs récompenses déclarées une fois qu'un membre en possède chaque objet, et des paquets. Les exemplaires d'un membre arrivent sous une clé qui fait compter chacun une seule fois : les ensembles de base à l'arrivée, un ensemble gagné contre des points ou acheté en entier, une récompense, un cadeau, l'objet du jour — un objet par jour, tiré d'un calendrier calculé à partir de dates fixes, de dates selon les règles propres à l'application et d'un tirage pondéré par la rareté les jours libres, remis sur l'activité des membres enregistrée par tilttek/activity —, ou un paquet, plusieurs objets tirés selon la rareté avec des chances publiées, à partir d'un germe engagé par le site et d'un germe du client donné par le membre, qui permettent à quiconque de rejouer le tirage. Les doubles sont comptés, l'album affiche 12 sur 20, et un ensemble complété pour la première fois est annoncé avec ses récompenses. Un membre choisit lesquels de ses dés affiche le lanceur de dés, les exemplaires passent d'un membre à l'autre lors d'un échange, et effacer un membre supprime ce que les collections gardaient de lui.

Elle s'adresse à un site qui donne à ses membres quelque chose à collectionner — les mascottes costumées d'un site communautaire, des cartes à échanger virtuelles, les dés d'un ensemble. tilttek/collections-bundle l'intègre à Symfony et garde le tout dans Doctrine DBAL. Une application sans Symfony prend la bibliothèque seule et écrit ses propres stockages, ou utilise ceux en mémoire.

C'est une bibliothèque PHP simple. Ses dépendances sont tilttek/activity, le journal sur lequel se réclame l'objet du jour, phil/resource, la référence opaque d'un membre, psr/clock, et les extensions mbstring et sodium. Les membres sont des références que donne l'application, member:44 : la bibliothèque ne lit jamais un nom, un courriel ou un compte. Elle ne dépend d'aucun autre paquet de ludification : les récompenses sont déclarées et l'application les remet, et tilttek/exchange atteint les exemplaires par l'inventaire que fournit le bundle.

La conception est petite : un Catalog contient des définitions Rarity, Item, ItemSet et Pack, lues par CatalogReader à partir de valeurs simples et fournies par un CatalogProvider. Collections remet des objets Copy sous une CollectionKey, les déplace, les reprend et construit l'Album. Packs engage un Pack en une PendingOpening, puis l'ouvre en une PackOpening à partir des Odds. DailyCalendar, Daily et DailyProjection remettent l'objet du jour. DiceShelf garde les dés qu'a choisis un membre. MemberData exporte et efface un membre.

État

Documentation

Démarrage rapide

composer require tilttek/collections

use Tilttek\Collections\Collections;
use Tilttek\Collections\FixedCatalog;
use Tilttek\Collections\Source;
use Tilttek\Collections\Store\InMemoryCompletionStore;
use Tilttek\Collections\Store\InMemoryCopyStore;

$catalog = FixedCatalog::fromArray([
    'rarities' => ['common' => 70, 'rare' => 25, 'legendary' => 5],
    'items' => [
        'deckhand' => ['name' => ['en' => 'Deckhand', 'fr' => 'Matelot'], 'rarity' => 'common', 'sets' => ['crew']],
        'captain' => ['name' => 'Captain', 'rarity' => 'legendary', 'sets' => ['crew']],
    ],
    'sets' => ['crew' => ['name' => 'The crew', 'rewards' => [['kind' => 'points', 'code' => 'xp', 'amount' => 50]]]],
]);
$collections = new Collections($catalog, new InMemoryCopyStore(), new InMemoryCompletionStore(), $clock);

$collections->grant($member, 'deckhand', Source::Purchase, 'order:2026-0193:line:1');
$collections->album($member)->set('crew')?->total(); // 2

Prérequis

PHP 8.5 ou plus récent, avec les extensions mbstring et sodium.

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. Voir LICENSE.