# How To Run VASSAL on SteamDeck **URL:** \ **Category:** Documentation\ **Created:** [April 3, 2024, 1:21pm UTC](https://forum.vassalengine.org/t/how-to-run-vassal-on-steamdeck/79338 "2024-04-03T13:21:26Z")\ **Posts on this page:** 1\ **Page:** 1
**Author:** ![cholmcc](https://forum.vassalengine.org/user_avatar/forum.vassalengine.org/cholmcc/32/8319_2.png) [@cholmcc](https://forum.vassalengine.org/u/cholmcc)\ **Post date:** [April 3, 2024, 1:21pm UTC](https://forum.vassalengine.org/t/how-to-run-vassal-on-steamdeck/79338/1 "2024-04-03T13:21:26Z")
# Background The [**SteamDeck**](https://store.steampowered.com/steamdeck/) from **Valve** is a portable console geared towards playing games from the [**Steam**](https://store.steampowered.com/) store. This store has a lot of different kinds of games available, ranging from causal games to monster strategic games. The hardware used in SteamDeck is pretty good, with 4 Zen 2 cores and 16GB of high-speed RAM. The console runs [**SteamOS**](https://store.steampowered.com/steamos) which is a variant of [**ArchLinux**](https://archlinux.org/). That means that the SteamDeck has all the power of a Linux machine that one can hope for in such a device. Typically, a SteamDeck device starts up in **gamescope** mode, which is essentially an shell dedicated to run the Steam application and to launch games. However, the SteamDeck can be switched into **desktop** mode where it will run a _full_ [**KDE Plasma**](https://kde.org/plasma-desktop/) desktop. This is the _modus-oprandi_ in which we will be running VASSAL. VASSAL is a Java application, which means we need a [Java Runtime Environment](https://en.wikipedia.org/wiki/Java_(software_platform)#Java_Runtime_Environment) (JRE) to execute it in. In particular, VASSAL needs the full Graphical User Interface (GUI) of JRE, called Swing, to execute properly. For Linux, that means we need either [**X**](https://www.x.org/wiki/) (nothing to do with the service formerly called _Twitter_, though that service as appropriated the X name and logo) or [**Wayland**](https://wayland.freedesktop.org/). The SteamDeck device can run KDE Plasma either on top of X or Wayland, so the SteamDeck is really a prime candidate for installing VASSAL. In the following, we will go through the steps needed to install and run VASSAL on your SteamDeck. # Installation ## Needed Software Since the SteamDeck in _desktop_ mode already runs X or Wayland, we really do not need much. - [VASSAL](https://vassalengine.org) (obviously) for Linux - A [VASSAL module](https://vassalengine.org/wiki/Category:Modules) to test things out. - [OpenJDK JRE](https://openjdk.org/) These are easily obtained on the SteamDeck. Below, we will assume your SteamDeck has internet access. We will mostly work from the [terminal](https://en.wikipedia.org/wiki/Terminal_emulator) (called [Konsole](https://konsole.kde.org/) in KDE). ### Important Command listed below must be typed into the terminal _exactly_ as written. Case matters, as in `downloads` and `Downloads` are _not_ the same thing. For example, if the instructions tells you to write ``` sudo steamos-readwrite enable ``` then two commands should be entered _exactly_ as written above at the command prompt. That is first, type `s` `u` `d` `o` `[space]` `s` `t` `e` `a` `m` `o` `s` `-` `r` `e` `a` `d` `w` `r` `i` `t` `e` `[space]` `e` `n` `a` `b` `l` `e` `[enter]`. If you are reading this on your StreamDeck, you can highlight the commands and copy them to your clipboard (`[ctrl]-c`). In terminal you can paste the command with `[ctrl]-[shift]-v` or use the **Paste** button. ## Preparations If your SteamDeck is currently in _gamescope_ mode, you _must_ switch to _desktop_ mode (see [here](https://help.steampowered.com/en/faqs/view/671A-4453-E8D2-323C) or [here](https://www.youtube.com/watch?v=Pc9thaq0KJc)). Essentially, - Press the **Steam** button - Select **Power** - Select **Switch to Desktop** - Wait for the device to switch to the desktop When the SteamDeck is in desktop mode, launch the terminal. - Press the Steam icon in the lower left corner (application menu) - Select **System** - Select **Konsole** ![steamdeck_01_terminal](https://forum.vassalengine.org/uploads/default/original/2X/b/b779d36ee618aa432466a736fbcac7cd70540d6b.jpeg) If you haven’t already, you need to set a password for the current user - `deck`. This is because we will use the application [`sudo`](https://en.wikipedia.org/wiki/Sudo) to install packages. `sudo` is a way to temporarily obtain super-user (or administrative) privileges on a Linux platform (something Windows only [recently](https://devblogs.microsoft.com/commandline/introducing-sudo-for-windows/) has obtained). To set a password for the `deck` user, execute ``` passwd ``` in the terminal. You should select a password that is reasonably safe (at least 8 characters, mixed lower and upper case letters, and at least one digit or other non-letter character), but also one you can remember. You _will_ need to remember it for all eternity. Once you have done this, you are ready to install VASSAL. ## The Quick Way This method _should_ work, but has not been tested thoroughly (I tested it in an [emulator](https://blogs.igalia.com/berto/2022/07/05/running-the-steam-decks-os-in-a-virtual-machine-using-qemu)). In the terminal run [`setup-vassal.sh`](https://gitlab.com/wargames_tex/vassal_my_contrib/-/raw/master/steamdeck/setup-vassal.sh) ``` wget https://gitlab.com/wargames_tex/vassal_my_contrib/-/raw/master/steamdeck/setup-vassal.sh -O setup-vassal.sh bash setup-vassal.sh ``` and follow the on-screen instructions ![steamdeck_02_setup](https://forum.vassalengine.org/uploads/default/original/2X/e/e98604a8236afb7661bd11457fb9bfbd0507054f.jpeg) Once the process has completed, you will have VASSAL installed ![steamdeck_03_done](https://forum.vassalengine.org/uploads/default/original/2X/0/0374f52c1930b53717a3efa847f4d77fe2b99466.jpeg) ## Detailed instructions If the above method fails, you can try to run them by hand. This will all be done in the terminal. If a step fails, do _not_ proceed to the next step. Instead, ask for help (with details about what you did and what went wrong) on the VASSAL [Technical Support & Bugs](https://forum.vassalengine.org/c/technical-support-bugs) Forum. ### Prepare the SteamDeck First, go to your home directory ``` cd ``` Here, `cd` means _change directory_ Put the SteamDeck into read/write mode ``` sudo steamos-readonly disable ``` You will be prompted for the password you set earlier . Then initialise the key-ring used to authenticate packages ``` sudo pacman-key --init sudo pacman-key --populate holo ``` (the last command is _essential_ as it allows the system to validate Valve build packages). Now install the [JRE](https://en.wikipedia.org/wiki/Java_(software_platform)#Java_Runtime_Environment) ``` sudo pacman -S -noconfirm --color auto --needed jre-openjdk ``` Put the system back in read-only mode ``` sudo steamos-readonly enable ``` With this, you SteamDeck has the needed software to run VASSAL. ### Download and install VASSAL Below, replace `3.7.9` with the version you want. In the terminal do ``` wget https://github.com/vassalengine/vassal/releases/download/VASSAL-3.7.9-linux.tar.bz2 ``` Unpack the package ``` tar xjvf VASSAL-3.7.9-linux.tar.bz2 ``` You will now have the directory `VASSAL-3.7.9` in your home directory ``` ls ``` Here, `ls` means _list_ content of current directory. You can now remove the downloaded archive ``` rm VASSAL-3.7.9-linux.tar.bz2 ``` Here, `rm` means _remove_ the named file. To make life a little easier you must create a symbolic link from the unpacked VASSAL directory ``` ln -s VASSAL-3.7.9 VASSAL-current ``` Here, `ln -s` means _create symbolic link_ (alias) _from_ `VASSAL-3.7.9` _to_`VASSAL-current`. And to make life even easier you must create an command alias for VASSAL ``` echo -e "\nalias vassal=$HOME/VASSAL-current/VASSAL.sh\n" > ~/.bashrc ``` Et _voila_, you are ready to go. Open a new terminal (or create a new tab in the current terminal with `[ctrl]-[shift]-t`) and close the old terminal (or tab). ## Additional (optional) steps ### Create a Desktop Icon to Launch VASSAL In the terminal do ``` nano ~/Desktop/VASSAL.desktop ``` `nano` is a small text editor. In `nano` type in the _exact_ lines ``` [Desktop Entry] Type=Application MimeType=application/x-vassal-module;application/x-vassal-log;application/x-vassal-save Name=VASSAL Exec=${HOME}/VASSAL-current/VASSAL.sh Icon=${HOME}/VASSAL-current/VASSAL.svg Actions=Run;Edit; Categories=Games [Desktop Action Run] Name=Run Exec=${HOME}/VASSAL-current/VASSAL.sh -l %f [Desktop Action Edit] Name=Edit Exec=${HOME}/VASSAL-current/VASSAL.sh -e %f ``` and then press `[ctrl]-x` followed by `y` and `[enter]`. See also [`~Desktop/VASSAL.desktop`](https://gitlab.com/wargames_tex/vassal_my_contrib/-/raw/master/common/VASSAL.Desktop). Change permissions of the file to be executable (i.e., make it an “application”) ``` chmod a+x ~/Desktop/VASSAL.desktop ``` Here, `chmod` means `change mode`, and `a+x` means make the named file executable (`+x`) by all (`a`). ### Associate VASSAL Modules and Logs with VASSAL This assumes you made the Desktop icon for VASSAL as described above. In the terminal, run ``` mkdir -p ~/.local/share/mime/packages nano ~/.local/share/mime/packages/application-x-vassal.xml ``` Here, `mkdir p` means make the named directory (and any parents needed). In `nano` type the _exact_ lines ``` VASSAL module file VASSAL log file VASSAL save file ``` followed by `[ctrl]-x`, `y`, and `[enter]`. See also [`~/.dot/local/share/mime/packages/application-x-vassal.xml`](https://gitlab.com/wargames_tex/vassal_my_contrib/-/raw/master/common/VASSAL.Desktop/dot-local-share-mime-packages-application-x-vassal-xml.txt). Then do ``` mkdir -p ~/.local/share/applications cp ~/Desktop/VASSAL.desktop ~/.local/share/applications/ ``` This will put a copy (`cp`) of your Desktop launcher in a place where KDE Plasma will look for applications. Then do ``` mkdir -p ~/.local/share/icons/hicolor/scalable/mimetypes/ cp VASSAL-current/VASSAL.svg ~/.local/share/icons/hicolor/scalable/mimetypes/application-x-vassal.svg ``` This will set an icon for VASSAL module, log, and save files. Now do ``` update-desktop-database ~/.local/share/applications update-mime-database ~/.local/share/mime ``` This will update the internal database used by KDE to find applications and the file associations # Running Whether you ran the `setup-vassal.sh` script or did the steps by hand, you should now be able to run VASSAL on your SteamDeck in _desktop_ mode. Open a terminal as described above and do ``` vassal ``` If you run the `setup-vassal.sh` script or installed a Desktop Icon and associated VASSAL module files with VASSAL, as described above, you can also launch VASSAL from the applications menu. - Press the SteamOS icon (application menu) in the lower-left corner of your screen - Select **Games** - Select **VASSAL** ![steamdeck_04_menu](https://forum.vassalengine.org/uploads/default/original/2X/1/1743e6aa994888694636935b9e4e506accc2e711.jpeg) Whether you executed VASSAL from the terminal or via the application menu, you should now see the VASSAL module manager window ![steamdeck_05_manager](https://forum.vassalengine.org/uploads/default/original/2X/a/a530d8c86a4e3372263467b288fc84d6137656c9.jpeg) The `setup-vassal.sh` has already downloaded the [Battle for Moscow](https://vassalengine.org/wiki/Module:Battle_for_Moscow) module for you, and put it in the directory `~/VMods`. ``` ls VMods ``` If you did the steps above by hand, you can obtain the same module with ``` mkdir -p ~/VMods wget https://obj.vassalengine.org/images/e/e1/BattleForMoscow-ch-1.0.vmod -O VMods/BattleForMoscow-ch-1.0.vmod ``` In the VASSAL module manager, open this module by - Select the **File** menu - Select **Open Module …** - In the file chooser dialog navigate to `VMods` and select `BattleForMoscow-ch-1.0.vmod` This will open the module. ![steamdeck_06_bfm](https://forum.vassalengine.org/uploads/default/original/2X/b/bddcee71d4b0251e7e8a7d48b6d1a15af685ab62.jpeg) You can also double-click any `.vmod`, `.vsav`, or `.vlog` file on your SteamDeck (via the file manager `Dolphin` - folder icon in the task bar) to open the module, save file, or log, respectively. ![steamdeck_07_fileman](https://forum.vassalengine.org/uploads/default/original/2X/b/bd59cf6dc61b25b4f9cac8aa57c3340ca506c200.jpeg) # Upgrading VASSAL To upgrade your VASSAL installation, download the new - say 3.7.10 - archive to your device ``` cd wget https://github.com/vassalengine/vassal/releases/download/VASSAL-3.7.10-linux.tar.bz2 ``` and unpack it ``` tar xvjf VASSAL-3.7.10-linux.tar.bz2 ``` Then remove the old `VASSAL-current` link, and recreate it to point the new installation ``` rm VASSAL-current ln -s VASSAL-3.7.10 VASSAL-current ``` You may want to delete the downloaded archive and the old installation - say 3.7.9 ``` rm VASSAL-3.7.10-linux.tar.bz2 rm VASSAL-3.7.9 ``` # Epilog I hope you will find this guide useful. Note that I have not tested this on an _actual_ SteamDeck device as I do not own such a device. However, I’ve tested the procedure on an [emulated SteamDeck device](https://blogs.igalia.com/berto/2022/07/05/running-the-steam-decks-os-in-a-virtual-machine-using-qemu). That means that I cannot vouch for any user experience with VASSAL and the SteamDeck, such as moving pieces, invoking the context menus, and so on. If you find any problems with this guide, please post a message in the VASSAL [Technical Support & Bugs](https://forum.vassalengine.org/c/technical-support-bugs) Forum. Please provide a _detailed_ account of what you did and what went wrong. Screenshots (via the app `Spectacle`) can be very useful. Enjoy.