Documentation menu

Installation

Description: Download Narratyr and activate a license on Windows, macOS, or Linux.

Draft. Public downloads aren't available yet.

Narratyr runs on Windows, macOS, and Linux. Each platform uses the same editor and document format, so teams can share projects across operating systems.

Requirements

Platform Requirements
Windows Windows 10 or later, 64-bit
macOS Apple silicon and Intel
Linux 64-bit desktop distribution

Install

Download the build for your platform from the pricing page. Follow the instructions below, then launch Narratyr and sign in or use the free tier.

Windows

Download and run the .exe installer. The installer adds Narratyr to the Start menu and registers supported project and license file types with Windows.

macOS

Open the .dmg, drag Narratyr into Applications, and launch it from there.

Linux

Narratyr provides three Linux package formats. Choose the package that matches your distribution and installation preferences:

Package Choose it when
.deb For Debian, Ubuntu, Linux Mint, Pop!_OS, and other Debian-based distributions. It integrates with desktop menus and the command line.
.snap For systems that use Snap. The sandbox prevents Narratyr from managing file associations. Use another package if you need to open Narratyr files from the file manager.
AppImage For Fedora, Red Hat Enterprise Linux, openSUSE, Arch, and distributions without .deb support. It also provides a portable installation without system packages.

Debian package

Install the package through your graphical software installer, or use apt:

sudo apt install ./narratyr_VERSION_amd64.deb

The ./ prefix tells apt to install the downloaded file instead of searching a configured repository. Replace VERSION with the version in the downloaded filename. The package installs the application launcher, supported file-type metadata, and narratyr-cli command.

Snap package

Install a downloaded Snap with:

sudo snap install --dangerous ./narratyr_VERSION_amd64.snap

Replace VERSION with the version in the downloaded filename. For a local file, --dangerous skips the Snap Store assertion check without disabling the sandbox. Only install packages downloaded from the Narratyr website. Update a local Snap by downloading and installing the newer package.

Narratyr's Settings > Files controls aren't available because the Snap sandbox can't reliably change file associations on the host desktop.

AppImage

An AppImage is the most portable option and doesn't need root access. Move it to its permanent path before the first launch:

mkdir -p "$HOME/Applications"
mv "$HOME/Downloads/narratyr-VERSION.AppImage" "$HOME/Applications/Narratyr.AppImage"
chmod +x "$HOME/Applications/Narratyr.AppImage"
"$HOME/Applications/Narratyr.AppImage"

Replace VERSION with the version in the downloaded filename.

On first launch, Narratyr registers its application launcher, icon, and supported file types for your user account. The launcher records the AppImage's absolute path. If you move or rename it later, launch it manually once from the new location to update that path. If you keep multiple copies, the most recently launched copy becomes the registered one.

AppImages require the Linux FUSE compatibility layer. If the AppImage reports that it can't mount or load libfuse.so.2, install your distribution's version 2 compatibility package. You can also use the native .deb or Snap package.

Licences and activation

The free tier doesn't require a license key. It includes the visual editor, open document format, and all engine exporters, with a limit of 500 nodes per project.

For paid licenses there are two options:

  • Monthly subscription. Narratyr checks activation every 30 days. You can use the licensed computer offline between checks. A subscription works with any version.
  • One-time purchase. Activates permanently for the purchased major version.

See pricing.

Updating

Narratyr doesn't check for updates automatically. Download updates manually so a team can keep each member on the same version.

Run the newer Windows, macOS, Debian, or Snap installer over the existing installation. For an AppImage, replace the file at the same path. If its filename or location changes, launch the new AppImage manually once so its application launcher and file associations point to the new path.