Frequently Asked Questions

Common questions about BranchPy, our licensing, features, and technical details.

๐Ÿš€ New to BranchPy?

โ“

What is BranchPy?

BranchPy is a toolkit that helps you create visual novels faster and with fewer bugs. It analyzes your game's script, shows you a flowchart of your story, finds errors before your players do, and helps you keep track of all your images and sounds.

Think of it as a quality control assistant that checks your work while you focus on writing great stories.

๐ŸŽ“

Is BranchPy beginner-friendly?

Yes! BranchPy was actually built by someone frustrated with making their first Ren'Py game. It's designed to help beginners catch mistakes they don't even know they're making.

You don't need to be a programmer. If you can write Ren'Py scripts, you can use BranchPy.

๐Ÿ’ก

How does BranchPy actually help me?

BranchPy does four main things:

  • Finds bugs: Spots missing labels, broken jumps, and unreachable scenes
  • Visualizes your story: Shows a flowchart of all your scenes and choices
  • Tracks assets: Makes sure all your images and sounds are properly referenced
  • Saves time: Instant analysis instead of manually testing every path

See real examples โ†’

๐Ÿ“‹ General Questions

โœ๏ธ

Does BranchPy edit my scripts?

No. We analyse, visualize, and help you run tests โ€” your code stays yours. Pro adds editable canvas to create new files on command, with confirmations.

๐ŸŽฎ

Which engines are supported?

Ren'Py first. Ports to other engines/editors will follow based on demand.

๐Ÿ”„

How do updates work?

Auto-update for the VS Code add-on; CLI via pip. Release notes are public.

๐ŸŽ

Is there a free version?

Yes! If you use Ren'Py, BranchPy is completely free โ€” all features, forever. Just claim your Ren'Py license.

For other engines, you can try BranchPy without an account (basic features) or create a free account for full core features. No time limit.

๐Ÿ”’ Privacy & Optional Features

๐Ÿ”’

Is AI required to use BranchPy?

No. AI is 100% optional and disabled by default.

BranchPy's core analysis engine is fully deterministic and runs locally on your machine. It reads your Ren'Py script structure to build flowcharts, detect issues, and compute statistics โ€” no AI involved in any of that.

Optional AI integrations can be manually enabled if you want AI-assisted checks, but they are never required for BranchPy to function. You bring your own API key; BranchPy never sends your scripts anywhere by default.

๐ŸŒ

Does BranchPy send my files to the cloud?

Not unless you explicitly allow it.

By default, no files leave your device.

You decide what is allowed, what is blocked, and what must be redacted.

๐Ÿ’ป

Can I use BranchPy completely offline?

Yes.

All local analysis, visualization, testing, and debugging are fully available offline.

Cloud AI = optional.

๐ŸŒŸ Community & Support

๐Ÿ’ก

Can I contribute or suggest features?

Yes! Use the Community page to request features, report bugs, or ask questions.