Installation
This guide covers downloading and installing StudioBrain, system requirements, first-run setup, and connecting to cloud services.
Desktop App (All Tiers)
The StudioBrain desktop app is built with Tauri 2.0 and available for Windows, macOS, and Linux.
Downloads
| Platform | Format | Minimum OS |
|---|---|---|
| Windows | .msi installer | Windows 10 (1809) or later |
| macOS | .dmg disk image | macOS 12 (Monterey) or later |
| Linux | .AppImage, .deb | Ubuntu 20.04+ / Fedora 36+ / equivalent |
Download the latest release from the StudioBrain website or from the GitHub Releases page.
System Requirements
| Component | Minimum | Recommended |
|---|---|---|
| CPU | Dual-core 2 GHz | Quad-core 3 GHz+ |
| RAM | 4 GB | 8 GB+ |
| Disk | 500 MB (app) + project size | SSD with 2 GB+ free |
| Display | 1280 x 720 | 1920 x 1080+ |
| GPU | Not required for app | Required only for local AI models (NVIDIA recommended) |
| Network | Not required (offline mode) | Required for cloud sync and managed AI |
Installing on Windows
- Download the
.msiinstaller. - Double-click the installer and follow the setup wizard.
- StudioBrain installs to
C:\Program Files\StudioBrain\by default. - Launch StudioBrain from the Start menu or desktop shortcut.
Installing on macOS
- Download the
.dmgdisk image. - Open the
.dmgand drag StudioBrain to your Applications folder. - On first launch, macOS may prompt you to allow the app. Open System Settings > Privacy & Security and click Open Anyway if needed.
- Launch StudioBrain from Applications or Spotlight.
Installing on Linux
AppImage (universal):
- Download the
.AppImagefile. - Make it executable:
chmod +x StudioBrain-*.AppImage - Run it:
./StudioBrain-*.AppImage
Debian/Ubuntu (.deb):
- Download the
.debpackage. - Install:
sudo dpkg -i studiobrain_*.deb - Launch from your application menu or run
studiobrainin a terminal.
First Run
When you launch StudioBrain for the first time, the app walks you through initial setup.
Step 1: Select a Project Folder
StudioBrain asks you to choose a project directory. This is the root folder where your entity files, templates, rules, and assets live.
- New project — Select an empty folder. StudioBrain creates the default directory structure including
_Templates/Standard/,_Rules/, and starter entity folders. - Existing project — Select a folder that already contains StudioBrain-compatible Markdown files. The app scans for templates, rules, and entities automatically.
Step 2: Initial Content Scan
After selecting a folder, StudioBrain performs an initial scan:
- Template discovery — Reads all files in
_Templates/Standard/to determine available entity types. - Rules loading — Reads all files in
_Rules/to load validation and generation rules. - Entity indexing — Parses all entity Markdown files and builds the local SQLite database cache.
- Asset scanning — Discovers images, audio, video, and other media files associated with entities.
The scan typically takes a few seconds for small projects and up to a minute for large ones (1,000+ entities).
Step 3: Configure AI Providers (Optional)
If you plan to use AI features, open Settings from the sidebar and enter your API keys:
| Provider | Where to Get a Key |
|---|---|
| OpenAI | platform.openai.com |
| Anthropic | console.anthropic.com |
| Google Gemini | aistudio.google.com |
| Grok | console.x.ai |
On the Free tier, you must provide your own API keys (BYO keys). Paid tiers include managed AI through StudioBrain’s orchestration service, with BrainBits credits for usage.
Step 4: Explore
With setup complete, you can:
- Browse entity types in the sidebar
- Create your first entity
- Open the AI Workshop to generate content
- Explore the Relationship Graph to see entity connections
Web Access (Indie+ Tiers)
Paid subscribers can access StudioBrain through the browser at studio.braindead.games.
Signing In
- Navigate to studio.braindead.games.
- Sign in with your StudioBrain account (created during subscription).
- Your cloud-synced projects appear on the dashboard.
Connecting Desktop to Cloud
To sync your desktop project with the cloud:
- Open Settings > Cloud Sync in the desktop app.
- Click Connect Account and sign in with your StudioBrain credentials.
- Choose a sync mode:
- Push — Upload your local project to the cloud for the first time.
- Pull — Download an existing cloud project to your local machine.
- Two-way Sync — Keep local and cloud copies synchronized automatically.
Google Drive Integration (Indie+ Tiers)
StudioBrain can sync entity files to Google Drive for additional backup and sharing.
Setting Up Google Drive
- Open Settings > Storage Providers in the desktop or web app.
- Click Connect Google Drive.
- Complete the OAuth consent flow — StudioBrain requests access to a dedicated folder in your Drive.
- Choose which project folders to sync.
StudioBrain creates a StudioBrain/ folder in your Google Drive and mirrors your project structure there. Only entity Markdown files and metadata are synced — large binary assets remain local unless you choose to include them.
What Gets Synced
| Content | Synced to Drive |
|---|---|
| Entity Markdown files (.md) | Yes |
| Template files | Yes |
| Rules files | Yes |
| Layout JSON files | Yes |
| Thumbnails and small images | Yes |
| Large binary assets (video, 3D models) | Optional |
Enterprise: Self-Hosted Instance
Enterprise customers can deploy StudioBrain on their own infrastructure.
Connecting to a Self-Hosted Instance
- Open the desktop app.
- Go to Settings > Cloud Connection.
- Under Instance URL, enter the URL of your self-hosted StudioBrain server (e.g.,
https://studiobrain.yourstudio.com). - Sign in with your organization credentials.
For self-hosted deployment instructions, see the Self-Hosting Guide.
Updating StudioBrain
Desktop App
StudioBrain checks for updates on launch. When an update is available:
- A notification appears in the app.
- Click Update to download and install the new version.
- The app restarts automatically after the update.
You can also check manually in Settings > About > Check for Updates.
Web App
The web app at studio.braindead.games is always running the latest version. No action required.
Troubleshooting Installation
Desktop app will not launch
- Windows: Make sure WebView2 Runtime is installed. StudioBrain requires it for rendering. Download from developer.microsoft.com.
- macOS: If blocked by Gatekeeper, open System Settings > Privacy & Security and click Open Anyway.
- Linux: Ensure
webkit2gtk(4.1+) andlibjavascriptcoregtkare installed. On Ubuntu:sudo apt install libwebkit2gtk-4.1-dev.
Initial scan is very slow
- Large projects with thousands of files may take longer on the first scan. Subsequent launches use the SQLite cache and are much faster.
- Ensure your project is on a local or fast-access drive, not a network share with high latency.
Cannot connect to cloud
- Verify your internet connection.
- Check that your subscription is active at studio.braindead.games/settings/billing.
- If using a self-hosted instance, confirm the instance URL is correct and the server is running.
Next Steps
- Getting Started — Overview of the application and interface navigation
- Managing Entities — Creating and editing entities with the template system
- Settings & Configuration — Detailed configuration options