BranchPy
Se connecter

Démarrage rapide en 3 minutes

Cette page vous amène de l'installation à un résultat utile rapidement.

Durée estimée : ~3 minutes
Fonctionne avec : Ren'Py 7.x et 8.x
Chemin recommandé : VS Code avec Control Center BranchPy

Ce que fait BranchPy en 30 secondes

BranchPy analyse les projets Ren'Py pour :

  • détecter les problèmes structurels et les chemins inaccessibles,
  • visualiser la structure narrative et les embranchements,
  • trouver les problèmes de médias comme les assets manquants ou inutilisés,
  • générer des rapports utilisables pour le débogage et le contrôle qualité.

Workflow principal (la plupart des utilisateurs s'arrêtent ici) :

branchpy --project <path> analyze    # analyse complète + rapport
branchpy --project <path> flowchart  # graphe narratif interactif

Améliorer votre projet :

branchpy --project <path> doctor     # diagnostiquer les problèmes de configuration
branchpy --project <path> compare    # comparer deux exécutions d'analyse

Analyse avancée (si nécessaire) :

branchpy --project <path> pilot      # axé sur les chemins, suivi des variables
branchpy omega --project-root <path> # bornes de variables et co-occurrence
branchpy --project <path> pfi        # index des fonctions et sauts

Ce que vous devriez voir après 3 minutes

  • Résumé d'analyse avec erreurs et avertissements.
  • Vue Flowchart séparée de votre structure narrative.
  • Résultats médias (par exemple, assets inutilisés ou manquants).
  • Navigation clic-pour-ouvrir depuis un résultat vers l'emplacement dans le code.

Exemple d'aperçu des résultats :

branchpy --project my-game analyze --open

Analyze complete
- labels detected: 52
- warnings found: 12
- errors found: 4
- flow outputs available: yes
Résumé du rapport Analyze

Pour qui :

  • Nouveaux utilisateurs souhaitant une première exécution guidée.
  • Équipes ayant besoin d'une base de référence prévisible avant un paramétrage approfondi.

Avant de commencer

  • Installez BranchPy depuis la page Téléchargement.
  • Utilisez une racine de projet Ren'Py valide (le dossier contenant game/ et les fichiers .rpy).

En cas d'échec, BranchPy expliquera ce qui est manquant ou incorrect (chemin invalide, fichiers manquants, structure non reconnue). Suivez le message — la plupart des problèmes à la première exécution sont des problèmes de chemin ou de racine de projet et se résolvent en une étape.

Structure de projet attendue :

my-game/
	game/
		script.rpy
		characters.rpy
		images/

Première exécution dans VS Code

Étape 1 : Installer et ouvrir le projet

  1. Installez Python 3.11+.
  2. Décompressez votre package pré-version BranchPy et lancez l'installateur :
    • Windows : double-cliquez sur install_branchpy.bat
    • macOS / Linux : chmod +x install_branchpy.sh && ./install_branchpy.sh
  3. L'installateur détecte VS Code et propose d'installer l'extension automatiquement.
  4. Ouvrez la racine de votre projet Ren'Py dans VS Code.

Étape 2 : Lancer Analyze

  1. Ouvrez le Control Center BranchPy.
  2. Sélectionnez votre projet.
  3. Cliquez sur Analyze.

Ce que vous devriez voir :

  • Résumé des erreurs/avertissements
  • Liens vers les vues de flux et de statistiques
  • Actions « aller au code » pour les résultats

Étape 3 : Examiner les résultats de flux

  1. Après la fin d'Analyze, cliquez sur Open Flowchart.
  2. Examinez le graphe pour repérer les nœuds déconnectés, les impasses, et les problèmes de forme des embranchements.
Vue d'ensemble du Flowchart

Étape 4 : Corriger un problème et confirmer avec Compare

  1. Ouvrez un problème à fort impact depuis Analyze.
  2. Appliquez la correction.
  3. Relancez Analyze — confirmez que le nombre s'améliore.
  4. Utilisez Compare pour vérifier qu'aucune régression n'a été introduite.

Première exécution en CLI

Première commande utile

branchpy --project path/to/project analyze --open

--open génère un rapport HTML autonome et l'ouvre dans votre navigateur par défaut. VS Code n'est pas requis.

Exemple de résultat :

Analyze complete
- labels detected: <n>
- warnings found: <n>
- errors found: <n>
- flow outputs available: yes

Étape 1 : Installer

pip install branchpy

Étape 2 : Lancer la première analyse

branchpy --project path/to/project analyze --open

Étape 3 : Effectuer un contrôle rapide

branchpy --project path/to/project stats --open

Étape 4 : Ouvrir le flux et effectuer un tri des médias

branchpy --project path/to/project flowchart --open
branchpy --project path/to/project media --open

flowchart --open génère un flowchart HTML interactif et l'ouvre dans votre navigateur. Dans VS Code, utilisez le bouton Flowchart du Control Center pour accéder au panneau interactif.

Pour un développement local déterministe, préférez :

.venv\Scripts\python.exe -m branchpy --project path/to/project analyze --open

Que corriger en premier

  • Commencez par les nouvelles erreurs avant les avertissements.
  • Résolvez les sauts/labels cassés avant le travail d'optimisation.
  • Relancez Analyze après chaque lot significatif de modifications.

Erreurs courantes à la première exécution

  • Mauvais dossier sélectionné (dossier parent au lieu de la racine du projet Ren'Py).
  • Supposer que les anciens rapports sont à jour après des modifications.
  • Mélanger les environnements (binaire branchpy du site utilisateur vs .venv actif).

Si cela ne fonctionne pas

Causes courantes :

  • Dossier du projet Ren'Py non détecté correctement.
  • Incompatibilité d'environnement Python.
  • Commande exécutée depuis le mauvais répertoire de travail.

Références de dépannage :

Prochaines étapes