VS Launcher Docs
DownloadHelpIssuesDonateDiscord
  • 👋Welcome
  • ❓What is VS Launcher?
  • GET STARTED
    • ⬇️Installation
      • Windows
      • Linux
      • MacOS
    • 🛠️Usage
      • 📖Concepts
      • 📀Game Client
        • Vintage Story is already installed
        • Install Vintage Story
        • Update Vintage Story
        • Uninstall Vintage Story
        • Play Vintage Story
        • Edit Installations
        • Installation Backups
        • Install/Manage Mods
    • 🌐Translation
      • Option 1
      • Option 2 (recomended)
  • IMPORTANT INFO
    • 👤Contributors
    • 📝Roadmap
Powered by GitBook
On this page
  • Vintage Story Dependencies
  • Debian, Ubuntu and their derivatives
  • Arch and its derivatives
  • SteamOS
  • Migrating from AppImage to Flatpak

Was this helpful?

  1. GET STARTED
  2. Installation

Linux

If you're using Linux follow this guide!

PreviousWindowsNextMacOS

Last updated 2 months ago

Was this helpful?

VS Launcher works on ANY Linux distro thanks to the AppImage compilation we're using.

Installing it on Linux is as easy as downloading the AppImage and double clicking it.... that's it. Let's get started:

1

Go to the

On that page you'll see all the available versions to download.

2

Download the Linux version

On the releases page, the first version is always the latest one. There you'll see a table with the different files to download. Just click on the Linux build as shown in the next image:

Flatpak option is NOT packaged with .NET so if you're using an immutable distro Vintage Story will not work!

I'm trying to add .NET to the .flatpak but idk if I'll be able to.

If you want you can use the DEB or Flatpak options but remember that those option have no automatic updates.

If you use any of this option just install it with double click or flatpak install vs-launcher-X.X.X.flatpak and then skip steps 3, 4 and 5. Just open it like any other app.

Flatpak will have automatic updates using Flathub bot for now on it'll need manual updates when a new version is released.

3

Move the AppImage to an accesible location

For example the Desktop, the you'll be able to open it whenever you want.

Some users reported that AppImage Launcher is breaking automaitc updates so if you want to use it make sure to download the latest VS Launcher version when it's published!

4

Add execution persmissions

This should be done by default by sometimes you've to manually do it.

chmod +x ./vs-launcher-X.X.X.AppImage
5

Open VS Launcher

Double click the VS Launcher AppImage and that's it, ready to use!

6

Install Dependencies

VS Launcher does not need any dependecy to work but Vintage Story does so follow the next steps.


Vintage Story Dependencies

VS Launcher does not need any dependencies to work, but Vintage Story does. I wanted to make this process automatic upon game launch but Linux has a lot of distros and I can't personalize it to work on all of them so you'll have to do it manually.

To help you with this process we've made a few guide explaining how to install every dependency needed on the most popular Linux distros.

Debian, Ubuntu and their derivatives

1

Install .NET 7

wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
chmod +x ./dotnet-install.sh
sudo ./dotnet-install.sh --channel 7.0 --install-dir /usr/lib/dotnet
2

Install your graphics driver

You'll have to look up how to do this for your graphics card and your Linux distribution as the combinations are almost endless!

3

Install OpenAL and mono-complete

sudo apt install libopenal-dev mono-complete
4

Fix RAM limits

sudo sysctl -w vm.max_map_count=262144

Arch and its derivatives

1

Install your graphics driver

You'll have to look up how to do this for your graphics card and your Linux distribution as the combinations are almost endless!

2

Install all the dependencies

sudo pacman -S dotnet-runtime-7.0 glibc openal opengl-driver mono

SteamOS

1

Disable readonly mode

SteamOS is protected so you can't make changes by accident. To install the dependencies you need to disable this:

sudo steamos-readonly disable
2

Configure pacman

Sometimes you'll need to do some steps to configure everything:

sudo pacman-key --init
sudo pacman-key --populate archlinux
sudo pacman-key --populate holo
3

Install all the dependencies

sudo pacman -S dotnet-runtime-7.0 glibc openal opengl-driver mono
4

Enable readonly mode again

sudo steamos-readonly enable

This SteamOS guide was sent by an user that got it working with this. I don't know what each stem does and didn't tested it.


Migrating from AppImage to Flatpak

AppImage and DEB options will use /home/username/.config as folder to store configs, game versions, installations... but Flatpak will use /home/username/.var/app/xyz.xurxomf.vslauncher/config for this so, if you were using AppImage or DEB builds of VS Launcher before and you install the Flatpak one you'll loose all your configs.

To restore the config you've to move the config file to the new location manually.

1

Find the old config file

This one will be at /home/username/.config/VSLauncher/config.json and copy it or move it to a save location.

2

Open the Flatpak installed VS Launcher

Open the VS Launcher copy you've installed using Flatpak and wait one or two seconds for it to generate the config file.

3

Go to the new config file location

This one should be at /home/username/.var/app/xyz.xurxomf.vslauncher/config/VSLauncher/config.json . If it's not there go to the setting page on VS Launcher and you'll have the 3 default folders. Just copy one of them as seen on the next video and open it.

4

Replace the config.json with the old one.

Just paste or move the old config file to the new location.

5

Restart VS Launcher

Close and open VS Launcher and magic, all your installations and versions are back!


If you find any issue report it on the and if you need help as us on the or on the .

⬇️
GitHub Issue Tracker
GitHub Discussions
Official Vintage Story Discord Server
GitHub Releases Page
Migrate to Flatpak | VS Launcher Guides