Slippi Stats Web

Slippi Stats Web est un projet visant à visualiser des données extraites depuis les fichiers replays de Slippi (.slp) dans une interface web. Le projet est hébergé sur Gitlab.

Une instance de démonstration est accessible sur https://slippi.mickaelgillot.xyz

Installation

Pré-requis

Il existe 3 façons d'installer Slippi Stats Web :

• Utiliser directement le fichier binaire exécutable pour Windows (.exe)
• Télécharger les sources pour lancer le programme avec Python
• Télécharger les sources pour lancer le programme via un container Docker

Pour ces 3 façons, vous trouverez des instructions détaillées dans les sections plus bas.

Installation avec les binaires (pour Windows uniquement)

1. Aller sur la page des releases du projet sur Gitlab et télécharger la dernière version du fichier Windows binaries (https://gitlab.com/Coukaratcha/slippi-stats-web/-/releases)
2. Désarchiver le fichier .zip dans le dossier de votre choix sur votre ordinateur
3. Aller dans le répertoire ssw/ et dupliquer le fichier config.cfg.sample. Renommer ce nouveau fichier en config.cfg.
4. Ouvrir le fichier config.cfg créé à l'étape précédente et remplir au minimum les trois valeurs suivantes :
   1. PLAYER_CODE : Votre code Slippi.
   2. REPLAYS : Le chemin vers le répertoire où sont stockés vos replays Slippi (.slp). Note : Vous devez doubler les anti-slashs (\) dans le chemin que vous rentrez. Par exemple, C:\Users\Couka\Documents\replays devient C:\\Users\\Couka\\Documents\\replays
   3. LOCAL_ONLY : Mettre "True" si l'application ne tournera que sur votre ordinateur sans qu'elle soit accessible depuis internet. Ne mettre "False" que si vous installez cette application sur un serveur ouvert sur Internet. Si vous avez mis "False" à LOCAL_ONLY, vous devez également remplir les deux champs suivants :
      1. SECRET_KEY : Mettre une chaine de caractères aléatoire. Il est recommandé d'utiliser un générateur de mot de passe.
      2. PASSWORD : Mettre un mot de passe. Ce mot de passe sera nécessaire pour accéder aux parties admin de l'application.
5. Lancer l'exécutable slippi-stats-web.exe en double-cliquant dessus.
6. Aller sur http://localhost:5000 dans le navigateur web de votre choix pour accéder à l'application.

Installation avec Python

Pour lancer le programme avec Python, il faut que Python 3 soit installé sur votre machine.

1. Récupérer les sources du programme en clonant le dépot ou en téléchargeant une archive avec le bouton Download.
2. Aller dans le répertoire web/app/ssw/ et dupliquer le fichier config.cfg.sample. Renommer ce nouveau fichier en config.cfg.
3. Ouvrir le fichier config.cfg créé à l'étape précédente et remplir au minimum les trois valeurs suivantes :
   1. PLAYER_CODE : Votre code Slippi.
   2. REPLAYS : Le chemin vers le répertoire où sont stockés vos replays Slippi (.slp). Note : Vous devez doubler les anti-slashs (\) dans le chemin que vous rentrez. Par exemple, C:\Users\Couka\Documents\replays devient C:\\Users\\Couka\\Documents\\replays
   3. LOCAL_ONLY : Mettre "True" si l'application ne tournera que sur votre ordinateur sans qu'elle soit accessible depuis internet. Ne mettre "False" que si vous installez cette application sur un serveur ouvert sur Internet. Si vous avez mis "False" à LOCAL_ONLY, vous devez également remplir les deux champs suivants :
      1. SECRET_KEY : Mettre une chaine de caractères aléatoire. Il est recommandé d'utiliser un générateur de mot de passe.
      2. PASSWORD : Mettre un mot de passe. Ce mot de passe sera nécessaire pour accéder aux parties admin de l'application.
4. Installer les dépendances en laçant la commande suivante : pip install -r requirements.txt
5. Lancer le programme en laçant la commande suivante : python run.py
6. Aller sur http://localhost:5000 dans le navigateur web de votre choix pour accéder à l'application.

Installation avec Docker

1. Récupérer les sources du programme en clonant le dépot ou en téléchargeant une archive avec le bouton Download.
2. Dupliquer le fichier production.env.sample et renommer le nouveau fichier en production.env.
3. Ouvrir le fichier config.cfg créé à l'étape précédente et remplir au minimum les deux valeurs suivantes :
   1. PLAYER_CODE : Votre code Slippi.
   2. LOCAL_ONLY : Mettre "True" si l'application ne tournera que sur votre ordinateur sans qu'elle soit accessible depuis internet. Ne mettre "False" que si vous installez cette application sur un serveur ouvert sur Internet. Si vous avez mis "False" à LOCAL_ONLY, vous devez également remplir les deux champs suivants :
      1. SECRET_KEY : Mettre une chaine de caractères aléatoire. Il est recommandé d'utiliser un générateur de mot de passe.
      2. PASSWORD : Mettre un mot de passe. Ce mot de passe sera nécessaire pour accéder aux parties admin de l'application.
4. Lancer le build de l'image et le lancement du container en laçant la commande suivante : docker-compose up -d
5. Déposer les fichiers à importer dans le dossier replays/ créé par docker-compose au lancement du container. Note : Vous pouvez remplacer ce dossier par un lien symbolique pointant vers un autre dossier où vous stockiez déjà vos fichiers pour ne pas avoir à les dupliquer.
6. Aller sur http://localhost:5000 dans le navigateur web de votre choix pour accéder à l'application.

Résolution des problèmes

Pour l'installation avec les binaires pour Windows, il est possible que votre logiciel anti-malware/anti-virus détecte le programme comme un logiciel malveillant. Pour tout de même lancer le programmer sans déclencher une alerte, rajoutez une exception pour le répertoire dans lequel est installé Slippi Stats Web.

Vous pouvez trouver des instructions détaillées pour ajouter une exception dans Windows Defender sur Windows 10 ici.