Skip to content

How to check for an App update

You'd like to know when a newer version of Armarius is out, without watching its GitHub page.

  1. Let it check. Once a day at most, when it starts, the app asks GitHub for the latest Release. It sends only its own version, and the check never holds the app up. If GitHub can't be reached, it says nothing and tries again next time.
  2. See the notice. When a newer version is out, the title page shows "! Armarius X.Y.Z is available" beside the version line, and the settings gear at the top right wears a small "!" seal. Click either to open the Settings window at its Update row.
  3. Read what's new. The Update row shows the new version, its date and the first lines of its notes. What's new shows all of them.
  4. Get it. Download page opens the Release's page in your browser. Then follow How to update the app: the app doesn't download or install anything itself. A copy run from the source says to pull main instead.
  5. Or skip it. Skip this version hides the notice until a newer Release. The Update row still shows the skipped version, faintly.
  6. Check now. Check now asks GitHub at once, whenever you like, and says what it found, or "Couldn't reach GitHub" and why.

Security fixes. When a Release's notes mark a security fix (a line starting Security:), the notice reads "Armarius X.Y.Z is available, with security fixes", in the theme's warning colour, and it can't be skipped. Move to it soon.

A new major version. When the first number changes (4 to 5), the notice says so: players who join by Remote seat must move to it too, as a seat needs the host's major version.

Turning it off. Untick Check for updates when Armarius starts on the Update row: the app then checks only when you choose Check now, and shows no notice. The desktop and terminal apps share the setting. Setting the environment variable ARMARIUS_UPDATES=off turns every check off, Check now included. A copy a host runs for a player, the host itself, and a saga self-hosted on a server never check.

See also: How to update the app, Title page