Skip to main content

Install and run

Runesmith runs on Windows, Linux and macOS. Download a release archive, or build it from source with the .NET 10 SDK. It comes with Git and GitHub support; languages such as C# and Java come from official plugins you install from the plugin hub.

Download a release​

Each release on the repository's Releases page has an archive per system. The archives hold everything Runesmith needs, including .NET, so nothing else has to be installed to run it.

SystemArchive
Windows (x64)runesmith-<version>-win-x64.zip
Linux (x64)runesmith-<version>-linux-x64.tar.gz
macOS (Apple silicon)runesmith-<version>-osx-arm64.tar.gz
  1. Unpack the archive. It holds a folder named runesmith.
  2. Start runesmith.exe on Windows. On Linux and macOS, run ./runesmith in that folder.

Add Runesmith to the Linux menu​

The Linux archive carries a menu entry and Runesmith's icon in every size, in its share folder. To add them for your account, run this in the runesmith folder:

mkdir -p ~/.local/bin ~/.local/share
cp -r share/. ~/.local/share/
ln -sf "$PWD/runesmith" ~/.local/bin/runesmith
update-desktop-database ~/.local/share/applications

Runesmith then shows in the application menu with its icon, opens runesmith:// links from the plugin hub, and runesmith starts it from a terminal when ~/.local/bin is on your PATH.

Build from source​

  1. Install the .NET 10 SDK.

  2. Clone Runesmith:

    git clone https://github.com/RunesmithHub/Runesmith.git

  3. Run Runesmith:

    cd Runesmith
    dotnet run --project src/Runesmith.App

Building and testing has more about building, such as building without the HammerUI checkout.

Set up C# or Java​

Completion, signature help, hover, go to definition, problems and builds for C# and Java come from the official C# and Java plugins. Install the ones you need from the plugin hub:

  1. Open Tools › Plugins and choose Browse, or start from the plugin's page on hub.runesmith.dev.
  2. Find C# or Java, and C# templates or Java templates for File › New Project, and click Install.
  3. Restart Runesmith when it offers to.

When you open a C# or Java file and its plugin is not installed, Runesmith offers it in a line over the editor; see Suggested plugins.

To load your solution and projects, with their references and C# version, the C# plugin needs the .NET SDK installed, as building does. Build also needs dotnet on the PATH. C# support and Java support have the details.