Page Navigation

<aside> 📔 TABLE OF CONTENTS

• General
• Multiplayer
• Windows
• Steam Deck
• Android
• Help Center

</aside>

Overview

Use this guide when you want to run Citron on the Steam Deck.  This just covers the basics of what you need and where to get it.

Terminology

• AppImage:
  • An AppImage is a portable application distribution format, essentially it takes an application and all the dependencies - and puts them into a single package. You as the user would just run the package, and it would handle everything else.
• Binary/Binaries:
  • Binary or Binaries are the raw program executable files. These contain program-compiled code and nothing else, ensuring that you have the right dependencies relies on the user and the environment.

Method 1: AppImage

1. Obtain an AppImage to Use
   1. You can either get a precompiled version or build one yourself, see the #Builds section for more information on these.

1. Press the STEAM button and go to Power > Switch to Desktop to launch the Desktop mode.

2. Move the AppImage onto your Steam Deck in somewhere accessible.

   1. Methods vary on how to do this and won't be talked thoroughly about here, but you can:
      • Use a file share on your network and access it from the Steam Deck
      • Download the AppImage directly on the Steam Deck
      • Use a 3rd Party utility to transfer it to your Steam Deck from your PC

3. Double-Click the AppImage to launch it.

   

   <aside> <img src="/icons/report_green.svg" alt="/icons/report_green.svg" width="40px" />

   TIP: You may get a pop-up when you first run it confirming that you want to launch the program, select Yes

   </aside>

4. Citron should now launch and you can set it up as you normally would.

Method 2: Native Binary

<aside> 🚨

Currently the dependencies to support running the native binary require that you have SteamOS 3.7.0 or higher installed, which is only available in the beta channel.  This will likely change in the future and the guide will be updated to reflect it.

</aside>

1. Press the STEAM button and go to your System settings tab.  Under Beta Participation > OS Update Channel, select Beta or Preview from the List.  You will need to restart your Steam Deck to download and apply the new update.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

INFO: You may have to perform an update check and restart multiple times until you get on the right version.

</aside>

1. Verify you are on the SteamOS 3.7.0 or higher by going to System > About in your settings, and looking at the OS Version number.

1. Download the latest Steam Deck Binaries from the Official Git Releases
2. The guide will stop here, currently the native binaries lack some implementations to get them to run, even on the supported SteamOS version. You will likely have to play around with the dependencies in order to get it to work. This is why this is not the recommended approach and should only be pursued by advanced power users.

Builds

<aside> 🚨

You should always use the official versions on the Git Releases where possible.  While these sources are generally accepted as safe and trustworthy - use your own best judgement on whether or not to use them.

</aside>

There are a few options that you have to get Citron on the Steam Deck.  Due to file size limitations that currently exist on the Git, an AppImage cannot be included in the official release, so we turn to these 2 methods.

Pre-Compiled Builds

These are builds that the community has built from the source code and hosted for people to use.  It is certainly the fastest way to get started, but may or may not have breaking changes, and would not necessarily be supported by the dev team in the future.

1. PKGFORGE (AppImage)
   1. This repository in GitHub builds releases every night, as well as for each major version release. Stick with the v3 AppImage for Steam Deck.
2. ESCARY BUILD (Native Binaries)
   1. This are PGO-Optimized Steam Deck compatible Linux binaries as of the time it was run (0.6), compiled by user @Escary. These are 0.6 binaries and have not been updated, so you will miss out on the latest changes until a new version is built.

Build it Yourself

These are methods and systems to use to build your own Binaries/AppImage.  It takes some time to set up and get a build, but you can be certain what goes into the build, have greater control over the process, and can build any version you want.

1. AzazelV's Appimage Builder: AppImage & Binaries
   • This repository in GitHub gives you a guided way of building Binaries, AppImages, or both using Docker. This is the recommended way to build one.

Resources

Citron Website

Download Citron

Citron Source Code

Citron Discord