🦑 s3s + Docker 🐳

Fork from s3s by frozenpandaman.

Edited for Docker Usage by BlocBlocTheBloc

DockerHub page

FR :

s3s est un script qui télécharge les données de bataille de Splatoon 3 depuis le service SplatNet 3 (une partie de l'application Nintendo Switch Online) vers stat.ink, un site pour enregistrer, visualiser et agréger les statistiques de la série de jeux Splatoon. Ce script fonctionne sur l'architecture Docker.

Usage via Docker 🐳

Outils nécessaires :

1. Config.txt extrait de s3s
2. Instance Docker fonctionnelle

Les étapes nécessaires à l'utilisation de s3s via Docker

Étape 1 - Config.txt

Pour faire fonctionner s3s-docker, vous devez d'abord avoir récupéré les informations de Config.txt après avoir lancé une première fois s3s sur votre ordinateur.

s3s-docker ne permet pas de configurer les tokens de lui-même.

Gardez bien ce fichier sur votre ordinateur.

Étape 2 - Configurer s3s

Maintenant que vous avez votre image de s3s dans Docker, il faut la paramétrer.

Allez dans la catégorie Stacks, puis cliquez sur "Add Stack".

Donnez un nom à votre Stack, par exemple "s3s".

Puis, dans "Web Editor", collez ce code :

version: '3'
services:
  s3s-docker:
    container_name: S3S
    image: blocblocthedev/s3s-docker:[?]
    environment:
      - api_key=[VOTRE API KEY]
      - acc_loc=[VOTRE RÉGION]
      - gtoken=[VOTRE GTOKEN]
      - bullettoken=[VOTRE BULLET TOKEN]
      - session_token=[VOTRE SESSION TOKEN]
    restart: unless-stopped

Remplacez ensuite :

• [?] -> Dernière version dans s3s-docker releases
• [VOTRE API KEY] -> La valeur entre "" de api_key dans Config.txt
• [VOTRE RÉGION] -> La valeur entre "" de acc_loc dans Config.txt
• [VOTRE GTOKEN] -> La valeur entre "" de gtoken dans Config.txt
• [VOTRE BULLET TOKEN] -> La valeur entre "" de bullettoken dans Config.txt
• [VOTRE SESSION TOKEN] -> La valeur entre "" de session_token dans Config.txt

Et cliquez sur "Deploy the Stack".

Vous pouvez aussi retrouvez le stack avec la version préremplis dans s3s-docker releases

Vous aurez ensuite dans votre liste de "Containers" une ligne nommée "S3S" avec comme statut "running".

Assistance

Si vous rencontrez des problèmes en souhaitant mettre en Docker votre s3s, reprenez le tutoriel avant de créer une Issue.

Que fait le container ?

Quand votre container est déployé et fonctionne, voici ce qu'il se passe :

1. Vérifie si des matchs n'ont pas été importés sur Stat.ink (Si c'est le cas alors il les importe).
2. Mise en mode passif, vérifie toutes les 5 minutes si de nouveaux matchs n'ont pas été importés (Si c'est le cas alors il les importe).

Suite du projet s3s-docker

Ce projet sera maintenu par BlocBlocTheBloc pendant une durée indéterminée.

Checklist des futurs ajouts (Possible mais pas sûr) :

• [] Option durée mode passif

Et bien d'autres...

Déclaration de licence et de copyleft - Par frozenpandaman

s3s est un logiciel libre sous licence GPLv3. Cela signifie que vous avez la liberté – d'exécuter, modifier, copier, partager et redistribuer ce travail comme bon vous semble, tant que les œuvres dérivées sont également distribuées sous ces mêmes termes ou des termes équivalents.

Le droit d'auteur est une invention humaine récente, confuse et souvent inutile. Les bibliothèques, par exemple, existent depuis des milliers d'années, et leur rôle essentiel dans la "promotion de la science" et "l'encouragement de l'apprentissage" a été reconnu bien avant la promulgation des premiers statuts sur le droit d'auteur. Si le premier humain ayant eu l'idée d'un marteau l'avait revendiquée comme sa propriété intellectuelle, nous n'aurions pas progressé très loin en tant qu'espèce. Veuillez envisager de partager votre travail ouvertement avec le monde. (déclaration adaptée de ici et ici)

Bien qu'il s'agisse d'un projet libre et open-source, sa licence nécessite une attribution. Si vous utilisez une partie de s3s, splatnet2statink, iksm.py, etc. dans votre projet, veuillez fournir un lien vers ce dépôt. J'ai passé plus d'une demi-décennie et des centaines d'heures de mon temps personnel sur ces projets pour la communauté Splatoon – donc, au moins, un peu de crédit serait apprécié. :) Les dons, via le bouton "Sponsor" en haut ou les liens dans la barre latérale, sont également grandement appréciés. Merci, et restez frais ! –eli ＜コ:彡

ENG - Partly from s3s README :

s3s is a script that uploads Splatoon 3 battle data from the SplatNet 3 service (part of the Nintendo Switch Online app) to stat.ink, a site for recording, visualizing, and aggregating statistics from the Splatoon series of games. This script runs on Docker architecture.

Usage via Docker 🐳

Required tools:

1. Config.txt extracted from s3s
2. A functional Docker instance

Steps necessary for using s3s via Docker

Step 1 - Config.txt

To run s3s-docker, you must first have obtained the information from Config.txt after running s3s on your local computer for the first time.

s3s-docker does not allow configuring the tokens by itself.

Keep this file on your computer.

Step 2 - Configure s3s

Now that you have your s3s image in Docker, you need to configure it.

Go to the Stacks category, then click on "Add Stack".

Give a name to your Stack, for example, "s3s".

Then, in "Web Editor", paste this code:

version: '3'
services:
  s3s-docker:
    container_name: S3S
    image: blocblocthedev/s3s-docker:[?]
    environment:
      - api_key=[YOUR API KEY]
      - acc_loc=[YOUR REGION]
      - gtoken=[YOUR GTOKEN]
      - bullettoken=[YOUR BULLET TOKEN]
      - session_token=[YOUR SESSION TOKEN]
    restart: unless-stopped

Remplacez ensuite :

• [?] -> Latest version in s3s-docker releases
• [YOUR API KEY] -> The value between "" of api_key in Config.txt
• [YOUR REGION] -> The value between "" of acc_loc in Config.txt
• [YOUR GTOKEN] -> The value between "" of gtoken in Config.txt
• [YOUR BULLET TOKEN] -> The value between "" of bullettoken in Config.txt
• [YOUR SESSION TOKEN] -> The value between "" of session_token in Config.txt

And click on "Deploy the Stack".

You can also find the stack with the pre-filled version in s3s-docker releases

You will then have a line named "S3S" in your "Containers" list with the status "running".

Assistance

If you encounter problems when trying to Docker your s3s, review the tutorial before creating an Issue.

What does the container do?

When your container is deployed and running, here is what happens:

1. Checks if matches have not been imported on Stat.ink (If so, then it imports them).
2. Enters passive mode, checks every 5 minutes if new matches have not been imported (If so, then it imports them).

Future of the project s3s-docker

This project will be maintained by BlocBlocTheBloc for an indefinite period.

Checklist of future additions (Possible but not certain):

• [] Passive mode duration option

And many more...

License & copyleft statement - By frozenpandaman

s3s is free software licensed under GPLv3. This means that you have freedom – to run, modify, copy, share, and redistribute this work as you see fit, as long as derivative works are also distributed under these same or equivalent terms.

Copyright is a recent, confusing, and often unnecessary human invention. Libraries, for example, predate copyright by thousands of years, and their integral role in the "promotion of science" and "encouragement of learning" was acknowledged even before the first copyright statutes were enacted. If the first human who had the idea of a hammer claimed it as their intellectual property, we wouldn't have gotten very far as a species. Please consider sharing your work openly with the world. (statement adapted from here and here)

While this is a free/libre and open-source project, its license does require attribution. If you are using any part of s3s, splatnet2statink, iksm.py, etc. in your project, please provide a link back to this repository. I have spent over half a decade and hundreds of hours of my personal time on these projects for the Splatoon community – so, at the least, some credit would be nice. :) Donations, via the "Sponsor" button at the top or links in the sidebar, are also greatly appreciated. Thank you, and stay fresh! –eli ＜コ:彡