Skip to content

How to update the app

A new version of Armarius is out, and the troupe wants to play on it before the next session.

  1. Agree on it with the troupe. Move to the new version together. An older version still opens a saga a newer one saved, but it says so and can't show what only the newer one knows. A player who joins by Remote seat needs the same major version as the host, the first number.
  2. See which version you have. The title page shows it, and so does the About page in Help.
  3. Download the new one. The app tells you when one is out (see How to check for an App update), and its Download page opens the Release. Or find it yourself on the app's GitHub page, under Releases. Read the new version's notes, then download the zip for your system, named like Armarius-X.Y.Z-windows.zip.
  4. Unzip it beside the old one. Extract it next to the old version's folder. It makes a folder of its own, Armarius-X.Y.Z.
  5. Start the new version. Start Armarius from the new folder, or armarius-terminal for the terminal version. Windows may say "Windows protected your PC" once for each version. Click More info, then Run anyway.
  6. Check your sagas. They're kept in your save folder, not in the app's folder, so the new version lists them as before, and keeps your settings too.
  7. Delete the old folder once the new version works.

A saga hosted on a server or NAS is updated there, on its own (see A newer version).

Running it from the source

  1. Get the new source. In the folder you cloned with git, run git pull. The main branch is always the latest release. Or download the release's Source code (zip) and extract it beside the old folder.
  2. Start it as before. On Windows, double-click run-gui.bat. On any system, run uv run python gui.py for the desktop version or uv run python main.py for the terminal version, in the folder. Both bring the app's libraries up to date first, so the first start after an update takes longer.

See also: How to download and run the app, How to check for an App update, Saga picker