tilttek/game-engine

tilttek/game-engine fait tourner les tables de jeux au tour par tour en ligne — un jeu de plateau ou de cartes, un jeu de taverne, un mini-jeu — ainsi que les tours et les phases d'une scène de jeu de rôle : l'exploration, puis une rencontre dans l'ordre d'initiative, puis ses suites. Il ne contient aucune règle : un jeu implémente un seul contrat et déclare ses phases, les transitions entre elles, le nombre de sièges d'une table, les options qu'il offre, qui agit dans chaque phase — n'importe qui, un siège après l'autre, par initiative, ou chaque siège une fois par ronde — et combien de coups terminent un tour. Le moteur vérifie les tours, change la phase par une machine à états de Symfony Workflow, ordonne les sièges par initiative et permet à un siège de retarder son tour, vérifie les options de la table avec l'OptionsResolver de Symfony, et demande au jeu si un coup est permis et ce qu'il change.

La vérité d'une table est son journal : le jeu et la version de ses règles, un germe de 256 bits, les sièges et les options, et chaque coup dans l'ordre, avec la mention qu'il a tiré au hasard ou non. L'état est un cache : rejouer le journal — la mise en place, puis chaque coup avec le hasard de sa place dans le journal — redonne le même état, ce que les tests vérifient et qu'un rejeu contrôle, en refusant un journal dont les coups ne s'appliquent plus ou tirent autrement ; on peut montrer aux joueurs un engagement sur le germe à l'ouverture de la table, avec lequel chacun vérifie le rejeu une fois la partie terminée. Le dernier coup peut être repris quand le jeu le permet, que la partie n'est pas terminée et que le coup n'a rien révélé. Ajouter un coup vérifie le nombre de coups et la révision du journal que le joueur a vus, de sorte que deux changements faits en même temps n'atterrissent jamais tous les deux ; une lecture coûte l'en-tête du journal et les coups faits depuis l'état en cache, lus fenêtre par fenêtre, une fois par requête ; et chaque changement est communiqué à un port d'éditeur — un concentrateur Mercure, par le bundle — avec des identifiants seulement ; chaque joueur lit ensuite la vue de son siège, qui omet les secrets des autres et suit ses propres préférences. Une partie qui se termine rapporte les statistiques qu'elle déclare, pour la table et pour chaque siège.

Il s'adresse à une application qui héberge des parties ou des scènes jouées à distance et veut que chaque table soit vérifiable, rejouable et protégée contre un joueur qui agit hors de son tour. C'est une bibliothèque PHP simple dont les dépendances sont symfony/workflow, la machine des phases, et symfony/options-resolver, les options d'une table. Un jeu prêt à l'emploi, RoleplayingScene, fait tourner les phases d'une scène sans les règles d'aucun système.

État

Documentation

Démarrage rapide

use Tilttek\GameEngine\{Games, Move, Tables};
use Tilttek\GameEngine\Scene\RoleplayingScene;
use Tilttek\GameEngine\Store\InMemoryLogStore;

$tables = new Tables(new Games(new RoleplayingScene()), new InMemoryLogStore());

$tables->open('roleplaying-scene', 'scene:12', ['seat:gm', 'seat:ann', 'seat:bob']);
$tables->play('scene:12', Move::initiative(['seat:ann' => 14, 'seat:bob' => 9], 'seat:gm'));
$state = $tables->play('scene:12', Move::transition('start-encounter', 'seat:gm'), expected: 1);

$state->turn->toAct();                       // ['seat:ann']
$tables->view('scene:12', 'seat:bob');       // what Bob sees
$tables->commitment('scene:12');             // shown to the players from the opening
$tables->finishedLog('scene:12');            // seed included, once the game is over, to verify every draw

Prérequis

PHP 8.5 ou une version plus récente.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite, en anglais. 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.