An mdbook for the Crayon Eaters family
Go to file
Dandaedre 271de9e20a
Gitea-Books/crayon_eaters/pipeline/head This commit looks good Details
Craftcraft, Death & Taxes, White knuckles
2026-09-24 17:12:39 +02:00
scripts Craftcraft, Death & Taxes, White knuckles 2026-09-24 17:12:39 +02:00
src Craftcraft, Death & Taxes, White knuckles 2026-09-24 17:12:39 +02:00
.gitignore Adds ignore 2025-04-01 08:45:24 -05:00
.ignore Addentum 2025-04-02 05:24:28 -05:00
Jenkinsfile Add Jenkinsfile 2025-07-02 22:34:05 +02:00
book.toml Tryout fix for newest book gen 2026-05-16 22:02:57 +02:00
readme.md Craftcraft, Death & Taxes, White knuckles 2026-09-24 17:12:39 +02:00

readme.md

Comment éditer

  • Rendez-vous sur le gitea (si vous lisez ceci vous y êtes probablement déjà) ;
  • connectez-vous si ce n'est pas déjà fait (en haut à droite) ;
  • rendez-vous dans le dossier src/ (en cliquant dessus) ;
  • une fois ici, plus qu'à cliquer sur le fichier que vous voulez éditer puis le crayon en haut à droite (ne le mangez pas celui-là) ; Si vous voulez créer un nouveau chapitre, il faut cliquer sur Add File en haut puis New File pour le créer et aller le rajouter dans SUMMARY.md pour qu'il apparaisse sur le bouquin.

Pour ajouter une image, il suffit d'aller l'uploader dans images/ (puis la référencer dans le .md);

Une fois vos modifications effectuées, envoyez-moi un MP pour que je mette la version en ligne à jour ! (On a pas encore d'automatisation malheureusement, quelle vie.)

Si ces instructions ne sont pas suffisemment claires (et je doute qu'elles le soient), s'il vous plaît dites-le moi que je les mette à jour avec ce qui manque.

— Vicky.

Ajouter ou déplacer un jeu en ligne de commande

Le script utilise uniquement Python 3, sans dépendance à installer (ni besoin de uv). Depuis la racine du dépôt :

  1. Ajouter un jeu dans les nouveautés à partir de son lien Steam, de son identifiant ou de son nom exact :

    python3 scripts/games.py add "https://store.steampowered.com/app/620/Portal_2/" --owners "Dandaedre, Vky"
    # Variante par nom (à utiliser à la place de la commande précédente) :
    python3 scripts/games.py add "Portal 2" --owners "Dandaedre, Vky"
    

    Le script récupère la description anglaise, les genres Steam et l'image dans src/images/. Les possesseurs sont obligatoires. En cas de recherche ambiguë, il affiche des liens candidats : relancer avec le bon lien ou identifiant. Une entrée existante n'est pas ajoutée une deuxième fois.

  2. Choisir éventuellement la catégorie dès l'ajout avec --category action, et remplacer les genres Steam par des tags personnalisés avec --tags "Puzzle, Co-op, Sci-fi". Sans --category, l'entrée va dans news. Les genres automatiques sont plus généraux que les tags communautaires Steam.

  3. Déplacer une entrée existante en donnant son titre complet et la destination :

    python3 scripts/games.py move "Portal 2" action
    python3 scripts/games.py move "Sworn" action --from aventure
    

    --from sert à préciser la source si le même titre figure dans plusieurs catégories. Tout le bloc est conservé, y compris les avis et les tags ; l'image reste au même endroit. Déplacer un jeu ne nécessite pas de connexion Internet.

Ajouter --dry-run à l'une des commandes pour prévisualiser sans écrire. Les catégories disponibles viennent de src/SUMMARY.md et sont listées par python3 scripts/games.py add --help ou python3 scripts/games.py move --help. Vérifier ensuite les modifications avec git diff avant de les publier. L'ajout nécessite Internet et dépend des endpoints publics du magasin Steam.

Pour lancer les vérifications hors ligne :

python3 -m unittest discover -s scripts -p 'test_*.py'