Install Guide (Linux)

This guide will walk you through installing and setting up Railyard on Linux.

Step 1 - Downloading Railyard#

To install Railyard on Linux, navigate to the download page. You should see a button with the auto-detected download for your operating system.

Install Flatpak if you do not have it already. You can find instructions for doing so here.

Once you have Flatpak installed, run the following command:

flatpak --user install <Railyard Flatpak Path>

This will install Railyard on your system.

Step 2 - Setting Up Railyard#

When you first launch Railyard, you will be asked to select your metro-maker4 folder.

image

If you did not manually modify this, click "Auto-Detect". Otherwise, select the location of this folder. Railyard will automatically validate it.

After, you will be asked to select your game executable. Once again, click "Auto-Detect" if you have not modified this. Otherwise, select the location of your game executable.

image

The next prompt will ask you to input your GitHub token. This is optional, but recommended to avoid hitting GitHub's API rate limits when using Railyard. If you do not have a token or do not wish to use one, simply click "Next" to continue with the setup process. You can always add a token later via the settings menu. To set up a GitHub token, see the GitHub Token guide.

The final prompt will ask you whether you want to enable automatic updates. This will allow Railyard to prompt you every time a new version is released, allowing you to easily stay up to date with the latest features and bug fixes.

Note

It is recommended to keep this enabled to ensure you have the latest features and bug fixes. This can be toggled at any time via the settings menu.

After that, you're ready to play! If you have any questions or run into any issues, feel free to ask questions in the Discord or raise an issue on GitHub.