UsersConnect Your Lore Server

Connect Your Lore Server

StudioBrain can use a lore repository as the authoritative store for your project’s content. Instead of writing entities and assets into object storage (S3, Google Drive, OneDrive), StudioBrain writes each change directly into a version-controlled lore repo — so every edit becomes a tracked revision you can branch, diff, merge and revert.

This guide walks through connecting a lore server end to end: configuring the connection, testing it, granting write consent, and confirming that an edit shows up as a new lore revision.

Lore is Epic Games’ next-generation version control for source code and large binary assets. The open-source LoreGUI desktop app can host a lore server for you, or you can point StudioBrain at any reachable lore server you already run.

What “connecting a lore server” actually does

StudioBrain supports two kinds of content backend:

Bring-your-own object storageLore federation
Source of truthMarkdown/asset files in your S3, Google Drive or OneDriveRevisions in your lore repository
HistoryObject versions (provider-dependent)Full lore revision history — branch, diff, merge, revert
Best forSolo and simple cloud projectsTeams who want real version control over canon and assets

When lore federation is connected, a product edit (PUT of an entity) is written as a new lore revision — the Markdown commit in your repo is the source of truth. StudioBrain’s cloud search index and vector store are kept in sync as a cache derived from those revisions; if they ever diverge, they’re rebuilt from lore.

Before you start

  • A lore server you can reach — either hosted for you by the StudioBrain desktop app (see the one-flow install below) or one you run yourself.
  • The relay URL, repository name and branch for that server (only needed for the bring-your-own path).
  • The right plan. Lore federation is a gated feature. Your account must be entitled to it (included on Team and above). If you don’t see the Lore option under storage settings, your current plan doesn’t include it yet — see Billing.

Entitlement is read from your signed session, not configured locally. Upgrading your plan unlocks the Lore storage option automatically the next time you sign in.

Choose your path

Desktop one-flow install

The simplest way to start. The StudioBrain desktop app bundles LoreGUI and sets everything up for you — there’s no separate server to install or expose.

Install the StudioBrain desktop app

Download and run the installer from studiobrain.ai. LoreGUI ships inside it as a sidecar; you don’t install it separately.

Desktop first-run storage step with the StudioBrain Lore provider selected.

Pick “StudioBrain Lore” on first run

On first launch, choose StudioBrain Lore as your project’s backend. The app spawns a local lore server over your project folder and begins hosting it.

Let it host, activate and connect

The desktop app advertises the hosted server through a secure relay, activates a write grant for your account, and connects StudioBrain to it — all in one flow. You don’t copy a URL or paste a token by hand.

The StudioBrain desktop app showing its bundled lore server hosted, activated and connected.

Start working

Create entities and assets as usual. Each edit is written into the hosted lore repo as a new revision. You can open LoreGUI at any time to branch, diff or merge that history.

Connecting is a deliberate, explicit grant. When you click Connect StudioBrain, a secure consent dialog opens and asks you to allow StudioBrain to read and write the repository you configured.

The Connect StudioBrain consent dialog requesting read and write access to your lore repository.

⚠️

Why the consent screen looks a little different. Consent, sign-in and anything touching your identity are handled by the StudioBrain accounts service in an isolated, same-origin window — never by the rest of the app. That separation is intentional: the product only ever receives an opaque grant reference, never a raw access token. Your write credential is minted and held on the server side, scoped to exactly the repository you consented to. You can revoke the grant at any time from your account settings.

After you approve, the dialog hands an opaque grant reference back to StudioBrain and the connection finishes establishing. The storage status flips to Connected.

Lore storage showing a connected status: health connected, repository and branch, and the latest synced revision.

Verify the write round-trip

To confirm everything is wired up, edit an entity and watch it land in lore:

Make an edit

Open any entity and change a field, or create a new one. Save it.

Confirm a new revision

The edit is written into your repository as a new lore revision. In LoreGUI (or your lore history view) you’ll see a fresh commit whose Markdown path matches the entity you changed.

An entity edit reflected as a new revision in the lore history, with the Markdown commit as the source of truth.

Check status stays healthy

Back in Settings → Storage → Lore, the status should remain Connected with a recent “last OK” time and zero consecutive failures.

If your relay briefly goes offline mid-edit, StudioBrain parks the write and replays it when the connection returns — without creating a duplicate revision. You don’t lose the edit.

Troubleshooting

A friendly configuration error explaining the relay is unreachable, with a retry action.

What you seeWhat it meansWhat to do
Lore option missing under storage settingsYour plan doesn’t include lore federationUpgrade to Team or above (see Billing), then sign in again
Invalid relay URLThe URL isn’t in lore://host:port/repo form, or the port is missingRe-check the scheme, host and explicit port
Relay unreachableStudioBrain couldn’t reach the relay hostConfirm the server is running and the relay/tunnel is up; re-run Test connection
Grant rejected / status shows Token expiredThe write grant is missing or expiredClick Connect StudioBrain again to re-grant consent
Status Reconnecting / OfflineA transient connection dropUsually self-heals; if it persists, verify the host and re-test
⚠️

A Test connection failure always names the stage it reached (parsed, tcp, authenticated, repo_resolved). The stage tells you where to look: a tcp failure is networking/relay; an authenticated failure is the grant; a repo_resolved failure is the repository name or branch.

For developers: the configuration API

The web and desktop UIs drive a small, stable set of product endpoints. These are internal to your StudioBrain tenant (authenticated with your session) — useful if you’re scripting setup:

  • GET /api/tenant/lore-config — read the current config (404 with ERR_LORE_NOT_CONFIGURED if none).
  • POST / PUT /api/tenant/lore-config — upsert { relay_url, repo_name, branch? }. The grant reference is never settable from the request body; your tenant is always taken from your signed session.
  • POST /api/tenant/lore-config/test-connection{ reachable, stage, health, error? }.
  • GET /api/lore/status{ configured, health, last_ok_at_secs_ago, repo_name, branch, relay_host }. The response never includes any token or grant reference.

Consent (the write grant) is not part of these endpoints — it’s always minted by the accounts service through the secure consent dialog, so a token never passes through a browser request body.

Next steps