dev:manual:getting-started:installing

Install and update smudgy

Smudgy has builds for Windows, macOS, and Linux. Download them from smudgy.org. A build copied from another site may have been changed; use the official download unless you intend to build and inspect the source yourself.

Install the application

Windows

Download the Windows installer, open it, and follow the prompts. If Windows reports an unknown publisher or invalid signature, stop and compare the download with the current instructions on smudgy.org.

macOS

Open the downloaded disk image and move Smudgy to Applications. If macOS reports that the application is damaged or cannot verify it, do not bypass the warning until you have confirmed that the file came from smudgy.org.

Linux

Download the Flatpak for your computer's architecture. Install it with your graphical software manager or with the command shown on the download page. Flatpak may install its runtime the first time.

The first launch opens the Connect window. Continue with Connect to a MUD. A cloud account is optional; local connections, automations, maps, and scripts work without one.

Install an update

When Automatically check for updates is enabled, Smudgy checks the official service for a newer version and shows an update notice when one is available. Follow its download link, close running Smudgy windows, and install the new build for your platform. Installing over the existing application keeps data stored in your Smudgy data directory.

Back up that directory before a major update or before moving between development and release builds. See Data files and backups. Do not copy a development data directory over a release directory as an update method.

Find the installed version

Use the installed-app details on Windows, Get Info on the macOS application, or flatpak info org.smudgy.Smudgy on Linux to find the current version. Include that version, your operating system, and whether the problem also occurs in an offline profile when reporting a problem. Do not include passwords, API keys, session tokens, or unredacted raw logs.