Minotaure

🇫🇷 Version française

English below.

AVERTISSEMENT

⚠️ Malgré leur vigilance, les contributeurs du code de Minotaure ne garantissent pas l'absence de failles de sécurité. Utilisation à vos risques et périls.

À quoi ça sert ?

Ce programme, installé sur un serveur, permet à des centaines de joueurs de participer à la même aventure en votant notamment pour la prochaine action à faire.

L'idée et le code d'origine ont été fournies par FibreTigre le 31/12/2020 sous le nom de ATRPG. Il a ensuite été repris et amélioré ici par les bénévoles. Il a été renommé "MINOTAURE" officiellement le 28/03/2021.

Découvrez des streams utilisant MINOTAURE sur le site minotau.re.

Rejoignez le discord de la communauté FibreTigre ou bien le discord dédié ici.

Installation locale sans Docker

1. Il vous faut un serveur avec PHP et une base SQL
2. Importez la base de données du fichier database.sql
3. Renommez le fichier src/connexion_example.php en src/connexion.php
4. Modifiez-le pour permettre la connexion à la base de données

Exemple : si votre base de donnée est locale, qu'elle s'appelle base1, que votre identifiant est toto et votre mot de passe titi, écrivez :

$db = new PDO('mysql:host=localhost;dbname=base1;', 'toto', 'titi');

5. Si vous utilisez la version 2.3 minimum, indiquez le chemin de vos fichiers temporaires à la place de /tmp (cette valeur par défaut marche sur beaucoup d'environnements, vous n'avez pas forcément besoin de la changer).

$tmp_path = '/tmp';

Les fichiers dans /src n'ont pas besoin d'être modifiés.

Installation locale avec Docker

Il faut avoir docker, docker-compose et make.

1. Cloner le repo : git clone https://github.com/fibreville/atrpg.git
2. Lancer les conteneurs : make up
3. Lancer le navigateur et aller sur [http://127.0.0.1:8080]
4. Créer le premier compte qui sera le MJ
5. Faire que son PC soit accessible depuis Internet : Aller sur la box, faire que le port 8080 de la box soit envoyé sur le port 8080 du PC. L'URL pour internet sera alors http://address-ip:8080.

• Pour voir les logs : make logs
• Pour arrêter les conteneurs : make down
• Pour détruire conteneurs et données : make reset

Pour jouer

• Le 1er compte créé sur le jeu est le compte admin (il peut avoir n'importe quel nom).
• Une fois ce compte créé et le joueur/MJ logué, il peut aller sur ecran.php et avoir accès à l'ensemble des commandes.
• Le mode de fonctionnement ensuite est détaillé ici : https://www.youtube.com/watch?v=XGU3_dczcNE

🇺🇸 English readme

WARNING

⚠️ This software may contain vulnerabilities. Use at your own risk.

Purpose

This program, installed on a server, allow several hundred players to live the same adventure by voting on the next action to do for the group, among other things.

The original code was publicly delivered by FibreTigre on the 31/12/2020 under the name ATRPG. It has been developed here since by volunteers. It was officially renamed "MINOTAURE" on the 28/03/2021.

Discover streams that use Minotaure on the official website minotau.re.

Join the FibreTigre discord community (in French + 1 English channel).

Install without Docker

1. Set up a PHP server with SQL
2. Import the database.sql file into you database (3 tables)
3. Rename src/connexion_example.php to src/connexion.php
4. Edit this file to grant access to the database

Example: if you use a local database named base1 with login foo and password bar, change the 3rd line to:

$db = new PDO('mysql:host=localhost;dbname=base1;', 'foo', 'bar');

5. Si vous utilisez la version 2.3 minimum, indiquez le chemin de vos fichiers temporaires à la place de /tmp (cette valeur par défaut marche sur beaucoup d'environnements, vous n'avez pas forcément besoin de la changer).

$tmp_path = '/tmp';

Other files in /src can be used as is.

Install using Docker

You will need docker, docker-compose and make.

1. Clone the repository: git clone https://github.com/fibreville/atrpg.git
2. Run containers: make up
3. Open a browser and go to [http://127.0.0.1:8080]
4. Create the first user (the GM)
5. Make your PC accessible from the Public Internet: open your router's configuration in your browser and set your router to forward the port 8080 of your router to your PC. Anyone may now access your server at http://address-ip:8080.

• To check the logs, type in a terminal: make logs
• To stop the containers: make down
• To delete containers and data: make reset

Tests unitaire (pour les developpeurs)

Installation de phpunit

./scripts/init_tests.sh

Lancement des tests

./phpunit tests/

How to play

• The first account you create will be the admin (it can have any name)
• After logging in with this account, the user may go to ecran.php and access all commands
• Et voilà !
• Demo video (in French): https://www.youtube.com/watch?v=XGU3_dczcNE