A lightweight, native shim for launching RuneLite on Linux with Jagex Accounts.

Note: This is relatively stable software. It should Just Work™ but I cannot account for every use-case in my own testing. Lemme know if it breaks.

What it does

You might wish to view rlshim like a very simplified Bolt. There's no RS3 support (nor do I plan on it), there's no custom launch command options (beyond passing flags to RuneLite), or custom RuneLite jar support (sorta, you can replace ~/.runelite/RuneLite.jar with whatever you want). However, compared to Bolt, rlshim offers:

• A native launcher for RuneLite that doesn't depend on the Chromium Embedded Framework. rlshim (including assets) weighs <16mb compared to Bolt's ~318mb installation.^[1]
• A more secure handling of credentials by using libsecret (i.e. gnome-keyring, kwallet, keepassxc, pass-secret-service, etc.) to store Jagex Account credentials encrypted and using syscalls to prevent process memory from leaking creds when it gets pulled out of storage. In the event that libsecret isn't available (or on handheld gaming distros like SteamOS), a local file store encrypted with AES-256-GCM is used.
• A non-obtrusive flow. The only time you'll see an interface is if it's your first time logging in, or you have to select a character (since Jagex Accounts support up to 20 linked).

When rlshim is installed, a desktop entry for RuneLite gets made. Running it runs rlshim, handling credentials and ensures RuneLite is available and Java exists to run it, then runs it. That's it.

[1] Combining du -h rlshim (in Release build) and du -h ./data, comparing to du -h ~/.local/share/flatpak/app/com.adamcake.Bolt/current/active/files/opt/bolt-launcher/, and that's not accounting for Flatpak-specific extras.

Installation

Where possible, rlshim supports x86_64 and aarch64 on glibc and/or musl based environments. For glibc-based environments (most of you), read below to find instructions for your distro. For musl-based environments, you'll need to use the binary .tar.gz releases -- I assume you know what you're doing.

⚠️ NOTE: RuneLite requires Java 11+. The distro packages (deb, rpm, AUR, Fedora, openSUSE) declare a JRE dependency and the Flatpak bundles one, so you shouldn't need to do anything. If you install via the raw .tar.gz binary release (or build it yourself), make sure Java 11+ is installed and java is available on your $PATH.

If your distro isn't here and you're willing to provide a mechanism to make packages for it, feel free to make a pull request.

Flatpak (Any Distro)

Pre-built .flatpak bundles are available on the Releases page. Download the appropriate architecture for your system and install it:

flatpak install ./life.srp.rlshim-*.flatpak

deb-based distros (Debian, Ubuntu, Mint, etc.)

Check the Releases page for pre-compiled .deb packages. Download the latest version and install it via:

sudo apt install ./rlshim-*.deb

Arch Linux (AUR)

For the stable binary release:

yay -S rlshim-bin

For the stable source release:

yay -S rlshim

For the "nightly" source release:

yay -S rlshim-git

Fedora (rpm-based)

Packages are built and hosted on COPR. You can install rlshim by adding the COPR repo and installing the package:

sudo dnf copr enable srp/rlshim
sudo dnf install rlshim

openSUSE (15.6, 16.0, Slowroll, Tumbleweed)

You can use the OBS Package Installer (opi) to install the package from the openSUSE Build Service:

sudo zypper in opi
opi rlshim

If you prefer using repos, you can install it with:

sudo zypper ar https://download.opensuse.org/repositories/home:/RdrSeraphim:/rlshim/$(lsb_release -d | sed 's/.* //')/home:RdrSeraphim:rlshim.repo
sudo zypper in rlshim

Nix / NixOS (Flakes)

Add the repo to your flake.nix inputs:

rlshim = { url = "github:RdrSeraphim/rlshim"; inputs.nixpkgs.follows = "nixpkgs"; };

Then add it to a package list somewhere:

environment.systemPackages = [
  inputs.rlshim.packages.${system}.default
];

Building

1. Install Dependencies

You will need a Rust toolchain (cargo and rustc), pkg-config, curl, and the libsecret development headers. Depending on your Linux distribution, install the following packages:

Debian / Ubuntu:

sudo apt install cargo rustc build-essential pkg-config libsecret-1-dev curl

Fedora / RHEL:

sudo dnf install cargo rust make gcc-c++ pkgconf-pkg-config libsecret-devel curl

Arch Linux:

sudo pacman -S rust base-devel pkgconf libsecret curl

2. Compile

There's a convenient Makefile wrapper to streamline building:

# Build the optimized release version (default)
make

# Build the debug version (with debugging symbols)
make debug

# Run unit tests
make test

# Build release packages (.deb, .rpm, .tar.gz)
make package

# Build debug packages (.deb, .rpm, .tar.gz)
make debug-package

# Install to system directories (installs bin, desktop entries, and assets)
sudo make install

# Uninstall from system directories (removes bin, desktop entries, and assets)
sudo make uninstall

# Clean the build artifacts
make clean

Usage & Flags

You can launch rlshim in your terminal or via your application launcher with the RuneLite desktop entry.

Usage: rlshim [OPTIONS]

Options:
  -t, --no-gui                      disables gui, all applicable prompts sent to stdout
  -l, --logout                      log out of rlshim, clearing all saved credentials
  -s, --use-saved-char              use the current saved character or, if none saved, save the character chosen at the selection menu
  -c, --clear-saved-char            clears the currently saved character. if --use-saved-char is set, this clears the saved character and will save the next selected character
  -f, --flags <RL_FLAGS>...         flags to pass to RuneLite
  -h, --help                        Print help
  -V, --version                     Print version

Options

• -t, --no-gui: Disables using any GUI. If you have multiple characters linked to your Jagex Account or it's your first time running rlshim, it will fall back to a terminal-based text prompt.
• -l, --logout: Safely deletes your saved Jagex Account credentials from your system keyring (libsecret) and local encrypted vault. The program will exit, and the next time you launch rlshim, you will be prompted to log in interactively again.
• -s, --use-saved-char: Automatically selects your previously saved character if you have multiple characters linked to your Jagex Account. If no character is saved yet, the character you choose at the selection prompt will be saved for future launches.
• -c, --clear-saved-char: Clears your currently saved character selection. If combined with -s / --use-saved-char, it clears the saved character and saves whichever character you select next.
• -f, --flags <RL_FLAGS>...: Passes one or more space-separated flags directly through to runelite.jar.

Forwarding Flags to RuneLite

Use -f / --flags to forward arguments to runelite.jar. Because RuneLite flags themselves start with -, pass them with = (or after --) so they aren't interpreted as flags for rlshim:

rlshim --no-gui -f="--mode=safe --developer-mode"

Will cause rlshim to use the CLI prompts where relevant (--no-gui), and then launch RuneLite with --mode=safe --developer-mode.

Credits

GUI background image from Jagex. Inform me if there's a more ethical way of sourcing it.

Some fonts and the RuneLite icon are sourced from RuneLite's repo.

BSD 2-Clause License

Copyright (c) 2016-2017, Adam <Adam@sigterm.info>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Some fonts also sourced from RuneStar's repo.