Skip to content
Blixt

Upgrading

Blixt ships as release zips you replace in your resources/ tree. Database schema changes are handled automatically — your config is the only thing that needs care.

Before upgrading

Section titled “Before upgrading”
  1. Back up your database. Migrations are forward-only; rollbacks require a restore.
  2. Back up your config.json. The new release zip will overwrite it. Save a copy somewhere outside the resource folder.
  3. Read the release notes. Posted in the Blixt Discord and linked from each new release on Tebex.

Upgrade steps

Section titled “Upgrade steps”

  1. Stop the FXServer (or at least the Blixt resources). Don’t try to hot-reload across versions — config or migration changes can leave the resource in a half-loaded state.

  2. Extract the new release zip over the existing folders:

    resources/[blixt]/blixt/
    resources/[blixt]/blixt-tablet/
    resources/[blixt]/blixt-business/

  3. Diff your config. Compare the new config.example.json against your saved config.json. New fields show up in the example first; port the ones you want into your config and put it back at resources/[blixt]/blixt/config.json.

  4. Start the FXServer. Watch the boot log:

    • [@blixt/database] Ran N migrations confirms schema is up-to-date.
    • [blixt] Loaded config.json confirms your config parsed.

  5. Smoke-test in-game. Open the phone, send a message to yourself, take a photo. If anything fails, the Troubleshooting page is the next stop.

Downgrading

Section titled “Downgrading”

There is no supported downgrade path. Once a migration runs, the schema is forward-only. To downgrade, restore the database backup you took before the upgrade and replace the resource folders with the previous release.

What about config.json overwrites?

Section titled “What about config.json overwrites?”

The current release process overwrites config.json on extract. Until we ship a separate config.user.json overlay file, the safest pattern is:

  • Keep your edits documented in a config.user.json you maintain yourself outside the resource (just for your own reference — Blixt doesn’t read it).
  • Diff against config.example.json after each upgrade to catch new fields.
  • Restart the resource after putting your config back.

We’re tracking the overlay-file pattern as planned work.