Third Party Emulation: Non-EmuDeck Tools and Resources
Learn how to install various tools and resources related to emulation on your Steam Deck outside of what EmuDeck installs. These tools and resources are either difficult to implement into EmuDeck's installation script directly, require elaborate setup, or may be added to EmuDeck in the future pending time and resources.
The guides on this page are not officially supported by EmuDeck. Many require some level of comfort in the terminal to successfully install. Regardless of your comfort with the terminal, the guides will cover as much detail as possible to address a wide variety of expertise levels. If you get stuck on a certain part, it is encouraged you Google and troubleshoot. The EmuDeck Discord will not be able to promise support for the guides available on this page.
Third Party Emulation Table of Contents
-
Decompilations and Reverse Engineered PC Ports
- Getting Started with Decompilations and Reverse Engineered PC Ports
- Games
- Cannonball OutRun Engine
- OpenGOAL: Jak and Dexter: The Precursor Legacy
- OpenGOAL: Jak II
- Perfect Dark
- Render96ex
- Ship of Harkinian: Ocarina of Time
- sm64ex
- sm64ex-coop
- Sonic 1 and 2
- Sonic CD
- Super Mario 64 Plus
- Super Mario Bros
- Super Mario Bros: The Lost Levels
- Super Mario World
- Super Metroid
- Super Metroid Redux
- zelda3: A Link to the Past
- General Maintenance
Decompilations and Reverse Engineered PC Ports
Getting Started with Decompilations and Reverse Engineered PC Ports
How to Set up Distrobox
Many of the decompilations and reverse engineered PC ports must be compiled. Compiling on the Steam Deck can be a bit tricky. Distrobox is one solution to make compiling these easy to do and any changes made within a Distrobox are retained on SteamOS updates.
This section will go over setting up a Distrobox, which you will utilize throughout this page.
Prerequisites: Sudo Password
Note: Skip this section if you have already set a sudo password
- In Desktop Mode, open
Konsole
, type inpasswd
, and press enter - You'll be prompted to create a password. Your text will not be visible. After you press enter, you will need to type your password again to confirm
- Exit out of Konsole
How to Install Distrobox
This will require your sudo password for the setup
- In Desktop Mode, open Konsole and enter the following lines, one at a time
curl -s https://raw.githubusercontent.com/89luca89/distrobox/main/install | sh -s -- --prefix ~/.local
sudo touch /etc/subuid /etc/subgid
sudo usermod --add-subuid 100000-165535 --add-subgid 100000-165535 $USER
- Download
podman-launcher-amd64
from https://github.com/89luca89/podman-launcher/releases to your/home/deck/Downloads
folder - Rename
podman-launcher-amd64
topodman
- Casing and spelling are important
- Right click
podman
, clickProperties
, clickPermissions
, checkIs executable
- Move the
podman
file to/home/deck/.local/bin/
~/.local
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, click "view hidden files" to see these folders
How to Configure bashrc
- In Desktop Mode, open the
/home/deck
folder- You may not see the word
deck
in the file path at the top, this is thehome
folder for thedeck
user
- You may not see the word
- Click the hamburger menu in the top right,
☰
, clickShow Hidden Files
- Right click
.bashrc
, clickOpen with Kate
or a file editor of your choice - Add these lines to the bottom of the
.bashrc
file
# Uncomment the xhost line below if you know that you are using xhost
#xhost +si:localuser:$USER
export PATH=$HOME/.local/bin:$PATH
- Save the
.bashrc
file and exit - If you had a terminal open previously (Konsole), close out of it and re-open before proceeding to the next section
How to Set Up Distrobox
- Open Konsole
- Create an Ubuntu Distrobox:
distrobox create --name ubuntu -i ubuntu:23.04
- If you get multiple options after inputting this command, select the
docker.io/library/ubuntu:##.##
image by pressing enter on the respective line
- If you get multiple options after inputting this command, select the
- To enter the Distrobox, open Konsole and enter:
distrobox enter ubuntu
- You will need to enter the Distrobox when compiling the various games on this page. You can identify when you are in a Distrobox by looking at the lefthand side of Konsole. Using the Distrobox created by this guide, it will say
deck@ubuntu
- You will need to enter the Distrobox when compiling the various games on this page. You can identify when you are in a Distrobox by looking at the lefthand side of Konsole. Using the Distrobox created by this guide, it will say
Terminal Tips and Tricks
cd
- Change directories
- For example, if you are working in a folder in terminal and need to change to a subfolder, enter
cd subfoldername
- You can press tab to auto-complete the sub-folder name as well
cd ..
orcd -
- Change into the previous directory
Tab
button- Auto complete file and path names
ls
orll
- List all of the folders and files in the current directory
~
can be used in place ofhome
- For example, if you have a folder in your
Applications
that you would like to navigate to, you can usecd ~/Applications
instead of typingcd /home/deck/Applications
- For example, if you have a folder in your
mkdir
- Create folders
- For example:
mkdir foldername
Ctrl
+C
- Terminate a running process
Up
arrow key button- Repeat last used command
Ctrl
+L
- Clear the screen
Ctrl
+U
- Clear current input
Ctrl
+A
- Jump to beginning of the line
Games
Cannonball - OutRun Engine
How to Build Cannonball on the Steam Deck
What is this?
CannonBall is a souped-up game engine for the OutRun arcade game.
Source: https://github.com/djyt/cannonball
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install -y sdl2-dev libboost-dev cmake make
Setting Up Cannonball
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/djyt/cannonball.git
- A
cannonball
folder will be created, ` - You will add your ROM files will be added after the build is finished
Building Cannonball
- In
/home/deck/Applications/Distrobox/cannonball
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
mkdir build
mkdir roms
cd build
cmake --fresh -DTARGET=linux.cmake -DOpenGL_GL_PREFERENCE=GLVND -DCMAKE_BUILD_TYPE="Release" -S ../cmake/
make -j4 VERBOSE=1
- Wait for it to finish building
Providing ROM Files for Super Cannonball
You must provide particular versions of the OutRun ROM files to run Cannonball. OutRun Revision B Roms need to unpacked into the cannonball/build/roms folder. The cannonball/roms/roms.txt file lists the expected file names to help you check that you have unpacked the correct files.
The location of suitable files cannot be linked here because they are copyright. When you have a suitable archive unpack it so that the files are directly in cannonball/build/roms and not in any subdirectory.
How to Configure Cannonball
See the Cannonball manual:
https://github.com/djyt/cannonball/wiki/Cannonball-Manual
No particular reconfiguration is needed for the Steam Deck. The game will default to 16:9 widescreen, and has no 16:10 mode, so there will be small black bars at the top and bottom of the SteamDeck screen. Options can be changed inside the Cannonball UI.
How to Run Cannonball
cd ~/Applications/distrobox/cannonball/build
./cannonball
OpenGOAL: Jak and Dexter: The Precursor Legacy
What is OpenGOAL: Jak and Dexter: The Precursor Legacy?
OpenGOAL is an unofficial port of Jak and Daxter: The Precursor Legacy for Windows and Linux.
Source: https://opengoal.dev/
Setting up OpenGOAL
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create anOpenGOAL
folder - Place your
Jak and Dexter: The Precursor Legacy
ISO directly in the newly createdOpenGOAL
folder - Download the latest
amd64.AppImage
from here: https://github.com/open-goal/launcher/releases/tag/v2.3.6 and place it in the folder you created in Step 1- Example: Download
open-goal-launcher_2.3.6_amd64.AppImage
- The version number may be different depending on when you are reading this
- Example: Download
- Right click
open-goal-launcher_#.#.#_amd64.AppImage
, clickProperties
, clickPermissions
, checkIs Executable
Installing OpenGOAL
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - Click
Set Version
, click theDownload
icon on the row with the latest version at the top - Click the circle icon on the left to select the version and click
Save
in the top right - On the left side, select
Jak and Dexter
- On the bottom right, click
Install via ISO
and select yourJak and Dexter: The Precursor Legacy
ISO - The application will begin to decompile your game, this may take a few moments
- Once it is finished decompiling, press
Continue
- To play your game, open this launcher, select
Jak and Dexter
on the left, and clickPlay
in the bottom right- The launcher does not work in Game Mode. See How to Add OpenGOAL: Jak and Dexter: The Precursor Legacy to Steam to learn how to play the game directly in Steam
How to Install Custom Textures
Note: Texture packs need to be zipped in order to be installed from the launcher. This section will use texture_replacements.zip
from https://www.youtube.com/watch?v=lX1gBO1INZ4 as an example.
- Download the custom textures from the pinned comment on this Youtube Video: https://www.youtube.com/watch?v=lX1gBO1INZ4 to
/home/deck/Applications/OpenGOAL
- Double click
open-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left side, select
Jak and Dexter
- On the bottom right, select
Features
,Texture Packs
- Click
Add New Pack
- Select
texture_replacements.zip
and wait a few moments - Your texture pack will appear below in its own box. Click the red
Disabled
button to enable your texture pack - Click
Apply Texture Changes
in the top right and wait a few moments - Your custom textures will now be installed
How to Add OpenGOAL: Jak and Dexter: The Precursor Legacy to Steam
- In
/home/deck/Applications/OpenGOAL
, right click anywhere in the blank space, clickCreate New
>Text File
- Name it
Jak and Dexter: The Precursor Legacy.sh
- At the top of the text file, write
#!/bin/bash
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left side, select
Jak and Dexter
- On the bottom right, click the
Gear
icon, and clickCopy Game Executable Command
- In the text file you created in Step 1, right click anywhere below
#!/bin/bash
and clickPaste
- Save the text file and exit out
- Right click your newly created text file, click
Properties
, clickPermissions
, checkIs Executable
- Right click the text file, click
Add to Steam
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Emulation/roms/desktop
instead- See How to Add Decompilations and Reverse Engineered PC Ports to Steam for further detail
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Your text file should look similar to the text below:
Text file name:
Jak and Dexter: The Precursor Legacy.sh
Text file contents:
#!/bin/bash
/home/deck/Applications/OpenGOAL/versions/official/v0.2.0/gk -v --proj-path /home/deck/Applications/OpenGOAL/active/jak1/data --game jak1 -- -boot -fakeiso
Note: You will need to update this shortcut whenever you update OpenGOAL.
OpenGOAL: Jak II
Preface
The folders in this section will be repeated from OpenGOAL: Jak and Dexter: The Precursor Legacy. If you have already installed Jak and Dexter: The Precursor Legacy, you may use the same folders and launcher to install Jak II.
What is OpenGOAL: Jak II?
OpenGOAL is an unofficial port of Jak II for Windows and Linux.
Source: https://opengoal.dev/
Setting up OpenGOAL
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create anOpenGOAL
folder - Place your
Jak II
ISO directly in the newly createdOpenGOAL
folder - Download the latest
amd64.AppImage
from here: https://github.com/open-goal/launcher/releases/tag/v2.3.6 and place it in the folder you created in Step 1- Example: Download
open-goal-launcher_2.3.6_amd64.AppImage
- The version number may be different depending on when you are reading this
- Example: Download
- Right click
open-goal-launcher_#.#.#_amd64.AppImage
, clickProperties
, clickPermissions
, checkIs Executable
Installing OpenGOAL
If you already installed OpenGOAL: Jak and Dexter: The Precursor Legacy, you do not need to do Steps 2 and 3 again.
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - Click
Set Version
, click theDownload
icon on the row with the latest version at the top - Click the circle icon on the left to select the version and click
Save
in the top right - On the left side, select
Jak II
- On the bottom right, click
Install via ISO
and select yourJak II
ISO - The application will begin to decompile your game, this may take a few moments
- Once it is finished decompiling, press
Continue
- To play your game, open this launcher, select
Jak II
on the left, and clickPlay
in the bottom right- The launcher does not work in Game Mode. See How to Add OpenGOAL: Jak II to Steam to learn how to play the game directly in Steam
How to Install Custom Textures
Note: Texture packs need to be zipped in order to be installed from the launcher.
- Download a texture pack of your choice
- Double click
open-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left side, select
Jak II
- On the bottom right, select
Features
,Texture Packs
- Click
Add New Pack
- Select your zipped texture pack and wait a few moments
- Your texture pack will appear below in its own box. Click the red
Disabled
button to enable your texture pack - Click
Apply Texture Changes
in the top right and wait a few moments - Your custom textures will now be installed
How to Add OpenGOAL: Jak II to Steam
- In
/home/deck/Applications/OpenGOAL
, right click anywhere in the blank space, clickCreate New
>Text File
- Name it
Jak II.sh
- At the top of the text file, write
#!/bin/bash
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left side, select
Jak II
- On the bottom right, click the
Gear
icon, and clickCopy Game Executable Command
- In the text file you created in Step 1, right click anywhere below
#!/bin/bash
and clickPaste
- Save the text file and exit out
- Right click your newly created text file, click
Properties
, clickPermissions
, checkIs Executable
- Right click the text file, click
Add to Steam
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Emulation/roms/desktop
instead- See How to Add Decompilations and Reverse Engineered PC Ports to Steam for further detail
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Your text file should look similar to the text below:
Text file name:
Jak II.sh
Text file contents:
#!/bin/bash
/home/deck/Applications/OpenGOAL/versions/official/v0.2.0/gk -v --proj-path /home/deck/Applications/OpenGOAL/active/jak2/data --game jak2 -- -boot -fakeiso
Note: You will need to update this shortcut whenever you update OpenGOAL.
Perfect Dark
What is This Decompilation?
A work-in-progress port of the Perfect Dark decompilation to modern platforms.
Source: https://github.com/fgsfdsfgs/perfect_dark
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following, one line at a time:
sudo dpkg --add-architecture i386
sudo apt-get update
- Enter the following:
sudo apt-get install git gcc g++ gcc-multilib g++-multilib make libsdl2-dev zlib1g-dev libsdl2-dev:i386 zlib1g-dev:i386
Setting Up Perfect Dark
Note: The following folder locations are recommendations. You may choose a different folder location.
- Download the
i686-linux
version from https://github.com/fgsfdsfgs/perfect_dark#download to yourDownloads
folder - Right click
pd-i686-linux.zip
, clickExtract archive here, autodetect subfolder
- Move the newly extracted
pd-i686-linux
folder to/home/deck/Applications
- Right click
pd
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Place your
Perfect Dark
ROM in/home/deck/Applications/pd-i686-linux/data
- MD5 Hash:
e03b088b6ac9e0080440efed07c1e40f
- To locate your MD5 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofMD5
and compare it to the above hash. If it is a match, you have a valid ROM 5
- MD5 Hash:
- In order to properly launch Perfect Dark, proceed to the next section
How to Launch Perfect Dark
- Download attached
.sh
file- PerfectDark.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
/home/deck/Applications
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Emulation/roms/desktop
instead- See How to Add Decompilations and Reverse Engineered PC Ports to Steam for instructions
- If you are using EmulationStation-DE or Steam ROM Manager, place in
- Right click
PerfectDark.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
PerfectDark.sh
to open Perfect Dark
How to Configure Perfect Dark
- Open
PerfectDark.sh
at least once so it can generate thepd.ini
file - Open the
/home/deck/.local/share/perfectdark/
folder~/.local
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, clickShow Hidden Files
to see these folders
- Right click
pd.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended Settings
- Set
DefaultWidth
to800
- Set
DefaultHeight
to1200
- Set
DefaultFullscreen
to1
Controls
https://github.com/fgsfdsfgs/perfect_dark#controls
Render96ex
How to Compile Render96ex on the Steam Deck
What is Render96ex?
An "HD" version of Super Mario 64 based on the rendered advertisements and art published in Nintendo Power.
Source: https://github.com/Render96/Render96ex/wiki
When you include the HD textures as part of this guide the whole Render96ex install will need 1.1GB of storage. This compares to less than 0.1 GB for the SM64Plus version of the game.
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install -y git build-essential pkg-config libusb-1.0-0-dev libsdl2-dev bsdmainutils libglew-dev
Setting Up Render96ex
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --single-branch --branch alpha https://github.com/Render96/Render96ex.git
- A
Render96ex
folder will be created, place your Super Mario 64 ROM in this folder - Rename the Super Mario 64 ROM to
baserom.us.z64
Building Render96ex
- In
/home/deck/Applications/Distrobox/Render96ex/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make -j4 TEXTURE_FIX=1
- Wait for it to finish building
- To play Render96ex, open
sm64.us.f3dex2e
in/home/deck/Applications/Distrobox/Render96ex/build/us_pc
How to Install Custom Models
- Download the latest model pack: https://github.com/Render96/ModelPack/releases to
/home/deck/Downloads
- Right click
Render96_DynOs_v3.2.7z
and clickExtract archive here, autodetect subfolder
- Move the newly extracted
Render96_DynOs...
folder to/home/deck/Applications/Distrobox/Render96ex/build/us_pc/dynos/packs
- To enable custom models, in game, press
Start
, pressL2
, selectModel Packs
and enableRender96DynOs...
How to Install Custom Textures
- In
/home/deck/Applications/Distrobox/Render96ex/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/pokeheadroom/RENDER96-HD-TEXTURE-PACK.git -b master
- Move the
gfx
folder in the newly clonedRENDER96-HD-TEXTURE-PACK
folder to/home/deck/Applications/Distrobox/Render96ex/build/us_pc/res
How to Configure Render96ex
- While in game, press
Start
, pressR1
- Configure settings
Ship of Harkinian: Ocarina of Time
What is Ship of Harkinian?
An unofficial PC port of The Legend of Zelda Ocarina of Time
Source: https://www.shipofharkinian.com/
Supported Legend of Zelda: Ocarina of Time ROMs
Note: You will need one of the following ROMs before you can proceed with the tutorial
Ocarina of Time Debug PAL GC (not Master Quest)
Currently the recommended option
Ocarina of Time PAL GameCube
May lead to crashes and instability
Ocarina of Time Debug PAL GC MQ (Dungeons will be Master Quest)
Build team: `zelda@srd022j`
Build date: `03-02-21 00:16:31` (year-month-day)
sha1: 079b855b943d6ad8bd1eb026c0ed169ecbdac7da (Produced by decomp)
sha1: 50bebedad9e0f10746a52b07239e47fa6c284d03 (Alternate)
Setting up Ship of Harkinian
Note: The following folder locations are recommendations. You can choose a different folder location.
- In
/home/deck/Applications
, create aShipofHarkinian
folder - Download the latest
Linux-Performance
version ofShip of Harkinian
: https://github.com/HarbourMasters/Shipwright/releases to the folder you created in Step 1- Download the
SoH-VERSION-NAME-Linux-Performance.zip
file
- Download the
- Right click the downloaded zip file and click
Extract archive here, detect subfolder
- Move the
soh.AppImage
to/home/deck/Applications/ShipofHarkinian
- Right click
soh.AppImage
, clickProperties
, clickPermissions
, checkIs Executable
Installing Ship of Harkinian
- Place your
The Legend of Zelda: Ocarina of Time
ROM in/home/deck/Applications/ShipofHarkinian
- Open
soh.AppImage
, wait - To play Ship of Harkinian, open
soh.AppImage
How to Install Custom Textures and Mods
Texture Pack and Mod Sources
This list is not exhaustive
How to Install Custom Textures and Mods
- In your Ship of Harkinian folder, create a
mods
folder, all lowercase/home/deck/Applications/ShipofHarkinian
if you used the folders in the above guide- Casing matters
- Place your mods or textures directly into this folder. Mods or textures typically have a
.otr
file extension- If you have a
.rar
or.zip
file, you will need to extract it first
- If you have a
- Depending on the mod or texture pack, you may need to enable it in game as well. Refer to the mod or texture pack for any additional instructions
sm64ex
What is This Decompilation?
A fork of sm64-port/sm64-port with additional features.
Source: https://github.com/sm64pc/sm64ex
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install build-essential git python3 libglew-dev libsdl2-dev bsdmainutils patch
Setting Up sm64ex
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/sm64pc/sm64ex
- A
sm64ex
folder will be created, place your Super Mario 64 ROM in this folder - Rename the Super Mario 64 ROM to
baserom.us.z64
Building sm64ex
- In the
sm64ex
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
- To play
sm64ex
, opensm64.us.f3dex2e
in/home/deck/Applications/Distrobox/sm64ex/build/us_pc
How to Configure sm64ex
- Open
sm64.us.f3dex2e
in/home/deck/Applications/Distrobox/sm64ex/build/us_pc
at least once so it can generate thesm64config.txt
file - Open the
/home/deck/.local/share/sm64ex/
folder~/.local
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, clickShow Hidden Files
to see these folders
- Right click
sm64config.txt
, clickOpen with Kate
or a text editor of your choice - Customize settings
How to Apply Patches
A 60 FPS patch is included with the GitHub repo for sm64ex. However, you can take what's written here and apply additional patches to sm64ex.
- In the
/home/deck/Applications/Distrobox/sm64ex/enhancements
folder, right click anywhere in the folder, clickOpen Terminal Here
- Enter:
git apply 60fps_ex.patch --ignore-whitespace --reject
60fps_ex.patch
is the name of the included file. If the file name is different, replace the file name in the above command
- You will need to re-build sm64ex for the patches to apply. To do so, enter the Ubuntu Distrobox and run
make clean
in the`/home/deck/Applications/Distrobox/sm64ex
folder
sm64ex-coop
What is This Decompilation?
Online multiplayer mod for SM64 that synchronizes all entities and every level for multiple players. Fork of sm64pc/sm64ex.
Source: https://github.com/djoslin0/sm64ex-coop
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install build-essential git python3 libglew-dev libsdl2-dev libz-dev bsdmainutils
Setting Up sm64ex-coop
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/djoslin0/sm64ex-coop.git
- A
sm64ex-coop
folder will be created, place your Super Mario 64 ROM in this folder - Rename the Super Mario 64 ROM to
baserom.us.z64
Building sm64ex-coop
- In the
sm64ex-coop
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make -j4
- Wait for it to finish building
- To play
sm64ex-coop
, opensm64.us.f3dex2e
in/home/deck/Applications/Distrobox/sm64ex-coop/build/us_pc
How to Configure sm64ex-coop
- Open
sm64.us.f3dex2e
in/home/deck/Applications/Distrobox/sm64ex-coop/build/us_pc
- On the main menu, click
Options
How to Play Multiplayer
See https://github.com/djoslin0/sm64ex-coop/wiki/Hosting-and-Joining.
Sonic 1 and 2
Preface
To compile Sonic 1 and 2, you will need a legally obtained copy of a Data.rsdk
file, obtained either from the Sonic 1 and 2 versions on the Android or iOS versions. For instructions, see Android and iOS.
What is This Decompilation?
A complete decompilation of Retro Engine v4 and the menus from Sonic 1 and 2 (2013).
Source: https://github.com/Rubberduckycooly/Sonic-1-2-2013-Decompilation
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install build-essential git libsdl2-dev libvorbis-dev libogg-dev libglew-dev libdecor-0-dev
Setting Up Sonic 1 and 2
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/Rubberduckycooly/Sonic-1-2-2013-Decompilation.git
- A
Sonic-1-2-2013-Decompilation
folder will be created
Building Sonic 1 and 2
- In the
Sonic-1-2-2013-Decompilation
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make -j5
- In the
Sonic-1-2-2013-Decompilation
, abin
folder will be created - If you would like to play both Sonic 1 and 2, make a copy of the
bin
folder directly in theSonic-1-2-2013-Decompilation
folder - Rename the original
bin
and the copied folder to Sonic 1 and Sonic 2 respectively- This step is for easier folder management, it is a recommendation and not a requirement
- Place the matching
Data.rsdk
in each folder - To play Sonic 1 and 2, open
RSDKv4
How to Configure Sonic 1 and 2
- In the respective Sonic 1 and 2 folder, after launching
RSDKv4
for the first time, asettings.ini
will be created - Right click
settings.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
How to Mod Sonic 1 and 2
Mod Resources
This list is not comprehensive
- In the respective
Sonic 1
orSonic 2
folders, create amod
folder - Download and extract mod(s) to the
mod
folder- A mod folder should typically have a
Data
folder and amod.ini
file
- A mod folder should typically have a
- Right click
settings.ini
, clickOpen with Kate
or a text editor of your choice - Change
DevMenu=false
toDevMenu=true
and save and close out of the file - While in game, press
Start
and you should see a list of your mod(s) - To activate/toggle a mod, press
A
on the respective mod
Sonic CD
Preface
To compile Sonic CD, you will need a legally obtained copy of a Data.rsdk
file, obtained either from the Sonic CD versions on the Android or iOS versions. For instructions, see Android and iOS.
What is This Decompilation?
A complete decompilation of Retro Engine v3/Sonic CD.
Source: https://github.com/Rubberduckycooly/Sonic-CD-11-Decompilation
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install build-essential git libsdl2-dev libvorbis-dev libogg-dev libtheora-dev libglew-dev
Setting Up Sonic CD
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/Rubberduckycooly/Sonic-CD-11-Decompilation.git
- A
Sonic-CD-11-Decompilation
folder will be created
Building Sonic CD
- In the
Sonic-CD-11-Decompilation
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make CXXFLAGS=-O2 -j5
- In the
Sonic-CD-11-Decompilation
, abin
folder will be created - Place the
Data.rsdk
you retrieved from How to Compile Sonic CD on the Steam Deck directly into thebin
folder - To play Sonic CD, open
RSDKv4
How to Configure Sonic CD
- In the
bin
, after launchingRSDKv4
for the first time, asettings.ini
will be created - Right click
settings.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
How to Mod Sonic CD
Mod Resources
This list is not comprehensive
- In the
bin
folders, create amod
folder - Download and extract mod(s) to the
mod
folder- A mod folder should typically have a
Data
folder and amod.ini
file
- A mod folder should typically have a
- Right click
settings.ini
, clickOpen with Kate
or a text editor of your choice - Change
DevMenu=false
toDevMenu=true
and save and close out of the file - While in game, press
Start
and you should see a list of your mod(s) - To activate/toggle a mod, press
A
on the respective mod
Super Mario 64 Plus
How to Compile Super Mario 64 Plus on the Steam Deck
What is Super Mario 64 Plus?
SM64Plus is a fork of sm64-port that focuses on customizability and aims to add features that not only fix some of the issues found in the base game but also enhance the gameplay overall with extra options.
Source: https://github.com/MorsGames/sm64plus
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install -y git build-essential pkg-config libusb-1.0-0-dev libsdl2-dev bsdmainutils
Setting Up Super Mario 64 Plus
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/MorsGames/sm64plus
- A
sm64plus
folder will be created, place your Super Mario 64 ROM in this folder - Rename the Super Mario 64 ROM to
baserom.us.z64
Building Super Mario 64 Plus
- In
/home/deck/Applications/Distrobox/sm64plus/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make -j4
- Wait for it to finish building
- To play Super Mario 64 Plus, open
sm64.us
in/home/deck/Applications/Distrobox/sm64plus/build/us_pc
- The game may have missing HUD UI textures, to fix these, read the next section
How to Fix the Missing HUD UI textures
- Download attached
.sh
file- SuperMario64Plus.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
/home/deck/Applications
- If you are using EmulationStation-DE or Steam ROM Manager, place in
Emulation/roms/desktop
instead- See How to Add Decompilations and Reverse Engineered PC Ports to Steam for instructions
- If you are using EmulationStation-DE or Steam ROM Manager, place in
- Right click
SuperMario64Plus.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
SuperMario64Plus.sh
to open SM64Plus
How to Configure Super Mario 64 Plus
- Open
sm64.us
in/home/deck/Applications/Distrobox/sm64plus/build/us_pc
at least once so it can generate thesettings.ini
file - Open the
/home/deck/Applications/Distrobox/sm64plus/build/us_pc
folder - Right click
settings.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended Settings
- Set
window_height
to800
How to Add Super Mario 64 Plus to Steam
- In
/home/deck/Applications
, right clickSuperMario64Plus.sh
, clickAdd to Steam
- After adding it to Steam, you may rename the shortcut in Steam directly
Super Mario Bros
How to Compile Super Mario Bros on the Steam Deck
Note: This section requires a legal copy of Super Mario World
and Super Mario All-Stars
ROMs for the SNES.
What is this?
A reverse engineered clone of Super Mario Bros.
Source: https://github.com/snesrev/smw
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following commands one at a time:
sudo apt install libsdl2-dev python3-pip make
sudo apt install python3-zstandard
How to Set Up Super Mario Bros
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/snesrev/smw smb1
- A
smb1
folder will be created, place yourSuper Mario All-Stars
ROM in/home/deck/Applications/smb1/other
- SHA256 Hash:
c05817c5b7df2fbfe631563e0b37237156a8f6b6
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the Super Mario World ROM to
smas.sfc
- Place your
Super Mario World
ROM in/home/deck/Distrobox/Applications/smbll
- SHA256 Hash:
6b47bb75d16514b6a476aa0c73a683a2a4c18765
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the
Super Mario World
ROM tosmw.sfc
How to Build Super Mario Bros
- In
/home/deck/Applications/Distrobox/smb1/other
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
python3 extract.py
- Change directories to
/home/deck/Applications/Distrobox/smb1
by entering the following:cd ..
- If you are not comfortable with the terminal, you may also open a terminal in
/home/deck/Applications/Distrobox/smb1
, enter the Distrobox again by entering:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
How to Play Super Mario Bros
- Download attached
.sh
file- smb1.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
/home/deck/Applications
- Right click
smb1.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
smb1.sh
to open Super Mario Bros
How to Configure Super Mario Bros
- In
/home/deck/Applications/Distrobox/smb1/
, right clicksmw.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended
- Set
Fullscreen
to1
Super Mario Bros: The Lost Levels
How to Compile Super Mario Bros: The Lost Levels on the Steam Deck
Note: This section requires a legal copy of Super Mario World
and Super Mario All-Stars
ROMs for the SNES.
What is this?
A reverse engineered clone of Super Mario Bros: The Lost Levels.
Source: https://github.com/snesrev/smw
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following commands one at a time:
sudo apt install libsdl2-dev python3-pip make git
sudo apt install python3-zstandard
How to Set Up Super Mario Bros: The Lost Levels
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/snesrev/smw smbll
- A
smbll
folder will be created, place yourSuper Mario All-Stars
ROM in/home/deck/Distrobox/Applications/smbll/other
- SHA256 Hash:
c05817c5b7df2fbfe631563e0b37237156a8f6b6
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the
Super Mario All-Stars
ROM tosmas.sfc
- Place your
Super Mario World
ROM in/home/deck/Distrobox/Applications/smbll
- SHA256 Hash:
6b47bb75d16514b6a476aa0c73a683a2a4c18765
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the
Super Mario World
ROM tosmw.sfc
How to Build Super Mario Bros: The Lost Levels
- In
/home/deck/Applications/Distrobox/smbll/other
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
python3 extract.py
- Change directories to
/home/deck/Applications/Distrobox/smbll
by entering the following:cd ..
- If you are not comfortable with the terminal, you may also open a terminal in
/home/deck/Applications/Distrobox/smbll
, enter the Distrobox again by entering:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
How to Play Super Mario Bros: The Lost Levels
- Download attached
.sh
file- smbll.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
/home/deck/Applications
- Right click
smbll.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
smbll.sh
to open Super Mario Bros: The Lost Levels
How to Configure Super Mario Bros: The Lost Levels
- In
/home/deck/Applications/Distrobox/smbll/
, right clicksmw.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended
- Set
Fullscreen
to1
Super Mario World
How to Compile Super Mario World on the Steam Deck
What is this?
A reverse engineered clone of Super Mario World.
Source: https://github.com/snesrev/smw
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following commands one at a time:
sudo apt install libsdl2-dev python3-pip make git
sudo apt install python3-zstandard
How to Set Up Super Mario World
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/snesrev/smw
- A
smw
folder will be created, place your Super Mario World ROM in/home/deck/Applications/smw
- SHA256 Hash:
6b47bb75d16514b6a476aa0c73a683a2a4c18765
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the Super Mario World ROM to
smw.sfc
How to Build Super Mario World
- In
/home/deck/Applications/Distrobox/smw/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
- To play Super Mario World, open
smw
in/home/deck/Applications/Distrobox/smw/
How to Configure Super Mario World
- In
/home/deck/Applications/Distrobox/smw/
, right clicksmw.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended
- Set
Fullscreen
to1
How to Mod Super Mario World
- In
/home/deck/Applications/Distrobox/smw/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
git clone https://github.com/snesrev/smw_hacks.git
- Enter:
pip install --break-system-packages --user bsdiff4
- Select a mod:
- You do not need to download any additional content from the links below. They are strictly for additional context on what the mod entails
- You can only have one mod active at a time. These mods will override the base Super Mario World game
- Return to Dinosaur Land
- Enter:
python3 assets/restool.py --hack=return_dino_land
- Enter:
- SMW with Levels from NSMB
- Enter:
python3 assets/restool.py --hack=nsmb
- Enter:
- Super Mario World Enhanced
- Enter:
python3 assets/restool.py --hack=enhanced
- Enter:
- Super Mario World Redrawn
- Enter:
python3 assets/restool.py --hack=redrawn
- Enter:
- To remove a mod and play vanilla Super Mario World
- Enter:
python3 assets/restool.py
- Enter:
- To play the mod you selected, open
smw
in/home/deck/Applications/Distrobox/smw/
Super Metroid
How to Build Super Metroid on the Steam Deck
What is this?
A reverse engineered clone of Super Metroid.
Source: https://github.com/snesrev/sm
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install libsdl2-dev python3-pip make git
Setting Up Super Metroid
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/snesrev/sm
- A
sm
folder will be created, place your US Super Metroid ROM in/home/deck/Applications/sm
- Rename the Super Metroid ROM to
sm.smc
Building Super Metroid
- In
/home/deck/Applications/Distrobox/sm
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
- To play Super Metroid, open
sm
in/home/deck/Applications/Distrobox/sm/
How to Configure Super Metroid
- In
/home/deck/Applications/Distrobox/sm/
, right clicksm.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Super Metroid Redux
How to Build Super Metroid Redux on the Steam Deck
What is this?
A port of Super Metroid Redux
: https://www.romhacking.net/hacks/4963/, using a reverse engineered clone of Super Metroid.
Source: https://github.com/testyourmine/sm-redux
Source: https://github.com/snesrev/sm
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following:
sudo apt install libsdl2-dev python3-pip make git
Patching Super Metroid Redux
- Download the patch here: https://www.romhacking.net/hacks/4963/
- Use the romhacking website here to patch your ROM: https://www.romhacking.net/patch/
Setting Up Super Metroid Redux
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/testyourmine/sm-redux
- A
sm-redux
folder will be created, place your patched US Super Metroid ROM in/home/deck/Applications/sm-redux
- Rename the patched Super Metroid ROM to
sm.smc
Building Super Metroid Redux
- In
/home/deck/Applications/Distrobox/sm-redux
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
- To play Super Metroid Redux, open
sm
in/home/deck/Applications/Distrobox/sm-redux/
How to Configure Super Metroid Redux
- In
/home/deck/Applications/Distrobox/sm-redux/
, right clicksm.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
zelda3: A Link to the Past
How to Compile zelda3 on the Steam Deck
What is zelda3?
A reverse engineered clone of Zelda 3 - A Link to the Past.
Source: https://github.com/snesrev/zelda3
Installing Prerequisites
- To do the steps in this section, you will need to have created an Ubuntu Distrobox. If you have not created one already, see How to Set up Distrobox for instructions
- Enter the Distrobox by opening Konsole and entering:
distrobox enter ubuntu
- Enter the following commands one line at a time:
sudo apt install libsdl2-dev python3-pip make git python3-zstandard python3-yaml python3-pillow
How to Set Up zelda3
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Applications
, create aDistrobox
folder - In the
Distrobox
folder, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone https://github.com/snesrev/zelda3
- A
zelda3
folder will be created, place your US Link to the Past ROM in/home/deck/Applications/zelda3
- SHA256 Hash:
66871d66be19ad2c34c927d6b14cd8eb6fc3181965b6e517cb361f7316009cfb
- To locate your SHA256 Hash, right click your ROM, click
Properties
, clickChecksums
, clickCalculate
to the left ofSHA1
and compare it to the above hash. If it is a match, you have a valid ROM
- SHA256 Hash:
- Rename the Link to the Past ROM to
zelda3.sfc
How to Build zelda3
- In
/home/deck/Applications/Distrobox/zelda3/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:distrobox enter ubuntu
- Enter:
make
- Wait for it to finish building
- To play zelda3, open
zelda3
in/home/deck/Applications/Distrobox/zelda3/
How to Configure zelda3
- In
/home/deck/Applications/Distrobox/zelda3/
, right clickzelda3.ini
, clickOpen with Kate
or a text editor of your choice - Customize settings
Recommended
- Set
ExtendedAspectRatio
to16:10
- Set
Fullscreen
to1
How to Customize Sprites
- In
/home/deck/Applications/Distrobox/zelda3/
, right click anywhere in the folder, clickOpen Terminal Here
, enter:git clone --recursive https://github.com/snesrev/sprites-gfx.git
- In
/home/deck/Applications/Distrobox/zelda3/
, right clickzelda3.ini
, clickOpen with Kate
or a text editor of your choice - Remove the
#
at the beginning of this line:# LinkGraphics = sprites-gfx/snes/zelda3/link/sheets/megaman-x.2.zspr
- Replace
megaman-x.2.zspr
with the sprite of your choice
For a full list of sprites, visit: http://alttp.mymm1.com/sprites/
To find the file name to place in zelda3.ini
- On http://alttp.mymm1.com/sprites/, right click the link above the sprite you would like to use, click
Copy Link
- In a new tab, paste the URL
- If you press enter, it will download the sprite
- The sprite file name will be at the end of the URL
- Example (Crewmate): https://alttpr-assets.s3.us-east-2.amazonaws.com/crewmate.2.zspr
- In
zelda3.ini
, replacemegaman-x.2.zspr
at the end:LinkGraphics = sprites-gfx/snes/zelda3/link/sheets/megaman-x.2.zspr
withcrewmate2.zspr
- Example:
LinkGraphics = sprites-gfx/snes/zelda3/link/sheets/crewmate2.zspr
How to Enable MSU1 CD Soundtrack Files
Choose a soundtrack from: https://www.zeldix.net/t791-the-legend-of-zelda-a-link-to-the-past
Example
- Download
Alternative New Soundtrack For Randomizers by JUD6MENT (updated: Sep 27, 2021)
from: https://www.zeldix.net/t791-the-legend-of-zelda-a-link-to-the-past to your/home/deck/Downloads
folder - Right click
Zelda Alternative Soundtrack by JUD6MENT (update Sep-21-2021).zip
, clickExtract archive here, autodetect subfolder
- Rename the newly extracted
Zelda Alternative Soundtrack by JUD6MENT (update Sep-21-2021)
folder tomsu
msu
is case sensitive
- Move the
msu
folder to/home/deck/Applications/Distrobox/zelda3/
- In
/home/deck/Applications/Distrobox/zelda3/
, right clickzelda3.ini
, clickOpen with Kate
or a text editor of your choice - Edit the line:
EnableMSU = false
so it instead writes:EnableMSU = true
- MSU1 CD Soundtrack Files are now enabled
General Maintenance
How to Add Decompilations and Reverse Engineered PC Ports to Steam
This section will use a simple script file to launch the various decompilations and reverse engineered ports on this page. You will need to create a script file per game.
How to Create Script Files
- Script Files: Group 1
- Script Files: Group 2
- Script Files: Group 3
- Script Files: Group 4
- Script Files: Group 5
Script Files: Group 1
- Cannonball OutRun Engine
- Render96ex
- sm64ex
- sm64ex-coop
- Sonic CD
- Sonic 1 and 2
- Super Mario Bros
- Super Mario Bros: The Lost Levels
- Super Mario World
- Super Metroid
- Super Metroid Redux
- zelda3: A Link to the Past
- In
Emulation/roms/desktop
, right click anywhere in the blank space, clickCreate New
>Text File
and give the text file a descriptive name (matching the game name typically) with a.sh
file extension- For example:
Super Metroid.sh
orThe Legend of Zelda: A Link to the Past.sh
- For example:
- Open the text file in a text editor of your choice
-
Enter the following (including the quotes):
#!/bin/bash cd "/path/to/game" "/path/to/gameexecutable"
-
Edit the path to where your game executable is located
- For example:
#!/bin/bash cd "/home/deck/Applications/Distrobox/sm" "/home/deck/Applications/Distrobox/sm/sm"
- For example:
-
Save and exit out of the file
- Right click the newly created file
- Click
Properties
- Click
Permissions
- Check
Is Executable
Note:
-
If your path is in the
home
directory, you may also replace/home/$USER
(home/deck
if you are on a Steam Deck) with$HOME
- For example:
#!/bin/bash cd "$HOME/Applications/Distrobox/sm" "$HOME/Applications/Distrobox/sm/sm"
- For example:
-
For
Super Mario Bros
andSuper Mario Bros: The Lost Levels
, you will also need to include the path to the respective game file in addition to thesmw
executable. For more information, see How to Play Super Mario Bros and How to Play Super Mario Bros: The Lost Levels.
Script Files: Group 2
- Download attached
.sh
file- SuperMario64Plus.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
Emulation/roms/desktop
- Right click
SuperMario64Plus.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
Script Files: Group 3
- Download attached
.sh
file- PerfectDark.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
Emulation/roms/desktop
- Right click
PerfectDark.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
PerfectDark.sh
to open Perfect Dark
Script Files: Group 4
- In a folder of your choice, create a text file and give it a descriptive name (matching the game name typically) with a
.sh
file extension- For example:
Ship of Harkinian.sh
- For example:
- Open the text file in a text editor of your choice
-
Enter the following:
#!/bin/bash "/path/to/gameexecutable"
-
Edit the path to where your game executable is located
- For example:
#!/bin/bash "/home/deck/Applications/ShipofHarkinian/soh.appimage"
- For example:
-
Save and exit out of the file
- Right click the newly created file
- Click
Properties
- Click
Permissions
- Check
Is Executable
Note:
- If your path is in the
home
directory, you may also replace/home/$USER
(home/deck
if you are on a Steam Deck) with$HOME
- For example:
#!/bin/bash "$HOME/Applications/ShipofHarkinian/soh.appimage"
- For example:
Script Files: Group 5
- In
Emulation/roms/desktop
, right click anywhere in the blank space, clickCreate New
>Text File
- Name it matching the respective Jak and Dexter game
- At the top of the text file, write
#!/bin/bash
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left side, select the matching Jak and Dexter game you created the script file for in Step 2
- On the bottom right, click the
Gear
icon, and clickCopy Game Executable Command
- In the text file you created in Step 1, right click anywhere below
#!/bin/bash
and clickPaste
- Save the text file and exit out
- Right click your newly created text file, click
Properties
, clickPermissions
, checkIs Executable
Note: You will need to update this shortcut whenever you update OpenGOAL.
How to Utilize Script Files with EmulationStation-DE
- Place your script files in
Emulation/roms/desktop
- In Game Mode, open EmulationStation-DE and play your newly created script files
How to Utilize Script Files with Steam ROM Manager
- Place your script files in
Emulation/roms/desktop
- In
/home/deck/.config/steam-rom-manager/userData/
, openuserConfigurations.json
in a text editor of your choice - Scroll to the very bottom of the text file, you will see a
}
and a]
, add a comma to}
-
Paste the below block of text between the
},
and the]
{ "parserType": "Glob", "configTitle": "Decompilations", "steamDirectory": "${steamdirglobal}", "steamCategory": "${Decompilations}", "romDirectory": "${romsdirglobal}/desktop", "executableArgs": "", "executableModifier": "\"${exePath}\"", "startInDirectory": "", "titleModifier": "${fuzzyTitle}", "fetchControllerTemplatesButton": null, "removeControllersButton": null, "imageProviders": [ "SteamGridDB" ], "onlineImageQueries": "${${fuzzyTitle}}", "imagePool": "${fuzzyTitle}", "userAccounts": { "specifiedAccounts": null }, "executable": { "path": "", "shortcutPassthrough": true, "appendArgsToExecutable": true }, "parserInputs": { "glob": "**/${title}@(.sh|.SH|.desktop|.DESKTOP)" }, "titleFromVariable": { "limitToGroups": "", "caseInsensitiveVariables": false, "skipFileIfVariableWasNotFound": false, "tryToMatchTitle": false }, "fuzzyMatch": { "replaceDiacritics": true, "removeCharacters": true, "removeBrackets": true }, "controllers": { "ps4": null, "ps5": null, "xbox360": null, "xboxone": null, "switch_joycon_left": null, "switch_joycon_right": null, "switch_pro": null, "neptune": null }, "imageProviderAPIs": { "SteamGridDB": { "nsfw": false, "humor": false, "styles": [], "stylesHero": [], "stylesLogo": [], "stylesIcon": [], "imageMotionTypes": [ "static" ] } }, "defaultImage": { "tall": null, "long": null, "hero": null, "logo": null, "icon": null }, "localImages": { "tall": null, "long": null, "hero": null, "logo": null, "icon": null }, "parserId": "168816977280299277", "version": 15 }
-
Open Steam ROM Manager, toggle the
Decompilations
parser and generate an app list to add your games to Steam
How to Update Decompilations and Reverse Engineered PC Ports
Updating: Group 1
- Render96ex
- Super Mario 64 Plus
- sm64ex
- sm64ex-coop
- Sonic 1 and 2
- Sonic CD
- Super Mario Bros
- Super Mario Bros: The Lost Levels
- Super Mario World
- Super Metroid
- Super Metroid Redux
- zelda3: A Link to the Past
- In the respective folder, open a terminal and enter:
git pull origin main
- If this does not work, try:
git pull origin master
- Resolve any conflicts
- If it states an ini file is in conflict, rename the pre-existing ini file and add a
.bak
at the end of the file name- For example:
smw.ini.bak
- For example:
- If it states an ini file is in conflict, rename the pre-existing ini file and add a
- Re-build the game
- You may need to do
make clean
first using a terminal in the root of the project folder - You may reference the various sections to re-build the game. The steps will be identical
- You may need to do
Updating: Group 2
- Download the
i686-linux
version from https://github.com/fgsfdsfgs/perfect_dark#download to yourDownloads
folder - Right click
pd-i686-linux.zip
, clickExtract archive here, autodetect subfolder
- Move the newly extracted
pd-i686-linux
folder to/home/deck/Applications
- Overwrite the current
pd
file - Right click
pd
- Click
Properties
- Click
Permissions
- Check
Is Executable
Updating: Group 3
- Download the latest
Linux-Performance
version ofShip of Harkinian
: https://github.com/HarbourMasters/Shipwright/releases to the folder you created in Step 1- Download the
SoH-VERSION-NAME-Linux-Performance.zip
file
- Download the
- Right click the downloaded zip file and click
Extract archive here, detect subfolder
- Move the
soh.AppImage
to/home/deck/Applications/ShipofHarkinian
- Overwrite the current
soh.AppImage
file - Right click
soh.AppImage
, clickProperties
, clickPermissions
, checkIs Executable
- When a new OTR is required, delete the current OTR files in
/home/deck/Applications/ShipofHarkinian
and re-run thesoh.AppImage
file by double clicking it to generate new OTR files
Updating: Group 4
- In
/home/deck/Applications/OpenGOAL
, double clickopen-goal-launcher_#.#.#_amd64.AppImage
to open it - On the left, select the
Gear
icon, clickVersions
at the top, click theDownload
icon on the top-most row (usually will also have the most recent date) - Click the circle icon on the left to select the version and click
Save
in the top right - Click the game you would like to update on the left
- You will receive a message requesting you to update the game, click
Update Game
and wait a few moments - Your game will now be updated to the latest version
Note: Do not forget to update the shortcut as well whenever you update OpenGOAL.
Emulators
BlueMaxima's Flashpoint
Link: https://gist.github.com/parkerlreed/4bd1f5fa38f7ffa72f9ceacb7d7f636d
Hypseus Singe
Link: https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#hypseus-singe-daphne
Sega Model 2: Model 2 Emulator
Setting up Model 2 Emulator
- Open https://github.com/PhoenixInteractiveNL/emuDownloadCenter/wiki/Emulator-m2emulator and download
1.1a
to theEmulation/roms/model2
folder - Right click
1.1a.7z
, clickExtract
>Extract archive here
- Extract
1.1a.7z
directly toEmulation/roms/model2
, if it creates a sub-folder, move the contents directly toEmulation/roms/model2
- Extract
- Create an additional
roms
folder inEmulation/roms/model2
- Download attached
.sh
file to theEmulation/tools/launchers
folder - Right click
model-2.sh
, clickProperties
, clickPermissions
, checkIs executable
- Download https://raw.githubusercontent.com/mozilla/fxc2/master/dll/d3dcompiler_47_32.dll to the
Emulation/roms/model2
folder - Rename
d3dcompiler_47_32.dll
tod3dcompiler_47.dll
- Place your zipped ROMs in
Emulation/roms/model2/roms
- You may now launch the Model 2 emulator by double clicking
model-2.sh
inEmulation/tools/launchers
The Emulation/roms/model2
folder should look similar to the tree output below:
srallyc.zip
in Emulation/roms/model2/roms
is being used as a ROM example. It will not be included with the Model 2 emulator.
Emulation/
└── roms
└── model2
├── d3dcompiler_47.dll
├── EMULATOR.EXE
├── EMULATOR.INI
├── emulator_multicpu.exe
├── README.TXT
├── roms
│ └── srallyc.zip
└── scripts
├── common.lua
├── daytona.lua
├── daytona.pat
├── mode_1.ps
├── mode_2.ps
├── model2.lua
├── model2lua.txt
├── srallycb.lua
└── srallyc.lua
EmulationStation-DE
Place your ROMs in Emulation/roms/model2/roms
- Download attached
.sh
file to yourDownloads
folder - Right click
model-2-esde.sh
, clickProperties
, clickPermissions
, checkIs executable
- Double click
model-2-esde.sh
to run it - Place your zipped ROMs in
Emulation/roms/model2/roms
- EmulationStation-DE will now be configured for Model 2
Steam ROM Manager
- Place your zipped ROMs in
Emulation/roms/model2/roms
- In
/home/deck/.config/steam-rom-manager/userData/
, openuserConfigurations.json
in a text editor of your choice - Scroll to the very bottom of the text file, you will see a
}
and a]
, add a comma to}
-
Paste the below block of text between the
},
and the]
{ "parserType": "Glob", "configTitle": "Sega Model 2 - Model 2 Emulator", "steamDirectory": "${steamdirglobal}", "steamCategory": "${Sega Model 2}", "romDirectory": "${romsdirglobal}/model2/roms", "executableArgs": "\"${fileName}\"", "executableModifier": "\"${exePath}\"", "startInDirectory": "", "titleModifier": "${fuzzyTitle}", "fetchControllerTemplatesButton": null, "removeControllersButton": null, "imageProviders": [ "SteamGridDB" ], "onlineImageQueries": "${${fuzzyTitle}}", "imagePool": "${fuzzyTitle}", "userAccounts": { "specifiedAccounts": "" }, "executable": { "path": "/run/media/mmcblk0p1/Emulation/tools/launchers/model-2.sh", "shortcutPassthrough": false, "appendArgsToExecutable": true }, "parserInputs": { "glob": "${title}@(.zip|.ZIP)" }, "titleFromVariable": { "limitToGroups": "${MAME}", "caseInsensitiveVariables": false, "skipFileIfVariableWasNotFound": false, "tryToMatchTitle": true }, "fuzzyMatch": { "replaceDiacritics": true, "removeCharacters": true, "removeBrackets": true }, "controllers": { "ps4": null, "ps5": null, "xbox360": null, "xboxone": null, "switch_joycon_left": null, "switch_joycon_right": null, "switch_pro": null, "neptune": null }, "imageProviderAPIs": { "SteamGridDB": { "nsfw": false, "humor": false, "styles": [], "stylesHero": [], "stylesLogo": [], "stylesIcon": [], "imageMotionTypes": [ "static" ] } }, "defaultImage": { "tall": "", "long": "", "hero": "", "logo": "", "icon": "/home/deck/.config/EmuDeck/backend/configs/steam-rom-manager/userData/img/default/icon.png" }, "localImages": { "tall": "", "long": "", "hero": "", "logo": "", "icon": "" }, "parserId": "169890088467987948", "version": 15, "disabled": false }
-
Open Steam ROM Manager, click the
Settings
button, change the theme toClassic
orDeck
- Select the
Sega Model 2 - Model 2 Emulator
parser on the left - Scroll down to the
Executable
box on the right. If the box is not red, you are all set, proceed to Step 10 - If the box is highlighted with a red outline, click
Browse
and navigate to where yourmodel-2.sh
is located - Click
Save
in the bottom left - Toggle the
Sega Model 2 - Model 2 Emulator
parser and generate an app list to add your games to Steam- Make sure your ROMs are in
Emulation/roms/model2/roms
- Make sure your ROMs are in
How to Configure Controls
- In Desktop Mode, open
model-2.sh
inEmulation/tools/launchers
- Load a game by clicking
Emulator
in the top left,Load ROM
, and selecting your ROM - Hold
Start
for three seconds to switch to Gamepad configs - Click
Game
at the top, clickConfigure Controls
- Configure controls
You may also try the pre-configured pack from Launchbox: https://forums.launchbox-app.com/files/file/3926-sega-model-2-emulator-everything-pre-configured-inc-controls-for-pc-controller-mouse-light-guns-test-menus-configured-analogue-inputs-calibrated-free-play-all-games-in-english-2-player-mouse-support-no-screen-flash/?_fromLogin=1 but there is a chance that the configuration files included may not work.
Sega Model 3: Supermodel
Note: The following folder locations are required so EmulationStation-DE can properly recognize the emulator and your ROMs.
Prerequisites:
- EmulationStation-DE 2.2
Setting up Supermodel
- In Desktop Mode, open Discover
- Search for Supermodel and download it
- Search for Flatseal and download it
- Open Flatseal and select
Supermodel
on the left - Scroll down to
Filesystem
and enableAll system files filesystem=host
- Download attached
.sh
file to yourDownloads
folder - Right click
supermodel-configurator.sh
, clickProperties
, clickPermissions
, checkIs executable
- Double click
supermodel-configurator.sh
to run it- You can confirm it worked by checking if a
.supermodel
folder was created in yourhome
folder~/.supermodel
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, clickShow Hidden Files
to see these folders
- You can confirm it worked by checking if a
EmulationStation-DE
After placing ROMs in Emulation/roms/model3
, open EmulationStation-DE
in Game Mode, and run your Supermodel 3 ROMs.
Note: Your ROMs should be zipped
Steam ROM Manager
- In
/home/deck/.config/steam-rom-manager/userData/
, openuserConfigurations.json
in a text editor of your choice - Scroll to the very bottom of the text file, you will see a
}
and a]
, add a comma to}
-
Paste the below block of text between the
},
and the]
{ "parserType": "Glob", "configTitle": "Sega Model 3 - Supermodel", "steamDirectory": "${steamdirglobal}", "steamCategory": "${Sega Model 3}", "romDirectory": "${romsdirglobal}/model3", "executableArgs": "run com.supermodel3.Supermodel \"${filePath}\"", "executableModifier": "\"${exePath}\"", "startInDirectory": "", "titleModifier": "${fuzzyTitle}", "fetchControllerTemplatesButton": null, "removeControllersButton": null, "imageProviders": [ "SteamGridDB" ], "onlineImageQueries": "${${fuzzyTitle}}", "imagePool": "${fuzzyTitle}", "userAccounts": { "specifiedAccounts": "" }, "executable": { "path": "/usr/bin/flatpak", "shortcutPassthrough": false, "appendArgsToExecutable": true }, "parserInputs": { "glob": "${title}@(.zip|.ZIP)" }, "titleFromVariable": { "limitToGroups": "${MAME}", "caseInsensitiveVariables": false, "skipFileIfVariableWasNotFound": false, "tryToMatchTitle": true }, "fuzzyMatch": { "replaceDiacritics": true, "removeCharacters": true, "removeBrackets": true }, "controllers": { "ps4": null, "ps5": null, "xbox360": null, "xboxone": null, "switch_joycon_left": null, "switch_joycon_right": null, "switch_pro": null, "neptune": null }, "imageProviderAPIs": { "SteamGridDB": { "nsfw": false, "humor": false, "styles": [], "stylesHero": [], "stylesLogo": [], "stylesIcon": [], "imageMotionTypes": [ "static" ] } }, "defaultImage": { "tall": "", "long": "", "hero": "", "logo": "", "icon": "/home/deck/.config/EmuDeck/backend/configs/steam-rom-manager/userData/img/default/icon.png" }, "localImages": { "tall": "", "long": "", "hero": "", "logo": "", "icon": "" }, "parserId": "169922790806455368", "version": 15 }
-
Toggle the
Sega Model 3 - Supermodel
parser and generate an app list to add your games to Steam- Note: Your ROMs should be zipped
Super Smash Bros: Project+
Link: https://gist.github.com/WingofaGriffin/3202698447ca2452a9431137cfc18d21
Emulation Related Games
AM2R
What is AM2R?
It is an unofficial remake of the 1991 Game Boy game Metroid II: Return of Samus in the style of Metroid: Zero Mission (2004).
Source: https://en.wikipedia.org/wiki/AM2R
How to Play AM2R
Note: You will need a copy of AM2R_1_1.zip
, this section will not cover how to obtain that file.
- In Desktop Mode, open Discover
- Search for AM2R
- Flathub page: https://flathub.org/apps/io.github.am2r_community_developers.AM2RLauncher
- Discover (on the Steam Deck) uses Flathub as its source for applications
- Flathub page: https://flathub.org/apps/io.github.am2r_community_developers.AM2RLauncher
- Download AM2R
- Open AM2R and click the big
Download
button on the main screen - Select
Select AM2R_1_1.zip
, select your file, and play the game
How to add AM2R to Steam
- Download attached
.sh
file - Place in
/home/deck/Applications
- Right click
AM2R.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
AM2R.sh
to open AM2R - In Desktop Mode, right click
AM2R.sh
, clickAdd to Steam
- Alternatively, use the Steam ROM Manager parser here: How to Utilize Script Files with Steam ROM Manager to add it to Steam
PokeMMO
Note: You will need a legal copy of the following games:
- Pokemon Black or Pokemon White
- Optional:
- Pokemon Fire Red
- Pokemon Platinum
- Pokemon Emerald
- Pokemon HeartGold or Pokemon SoulSilver
How to Install PokeMMO
Note: The following folder locations are recommendations. You may choose a different folder location.
- In
/home/deck/Games
, create aPokeMMO
folder - In
/home/deck/Games/PokeMMO
, create ajdk
folder - Download Java OpenJDK: https://jdk.java.net/19/ to
/home/deck/Games/PokeMMO
- Download
Linux / x64 tar.gz (sha256) 195931906
- Download
- Download PokeMMO: https://pokemmo.com/downloads/linux/ to
/home/deck/Games/PokeMMO
- Under
Other Distributions
, clickDownload the Client
- Under
- Extract
PokeMMO-Client.zip
in/home/deck/Games/PokeMMO
- Extract
openjdk-19.0.2_linux-x64_bin.tar.gz
to/home/deck/Games/PokeMMO/jdk
- To launch the game, open
Konsole
and enter:/home/deck/Games/PokeMMO/jdk/bin/java -jar PokeMMO.exe -cp com.pokeemu.client.Client
How to add PokeMMO to Steam
- Download attached
.sh
file- PokeMMO.sh
- Note: If you are using different folder locations, make sure to edit the above file and edit the paths
- Place in
/home/deck/Applications
- Right click
PokeMMO.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
PokeMMO.sh
to open PokeMMO - In Desktop Mode, right click
PokeMMO.sh
, clickAdd to Steam
- Alternatively, use the Steam ROM Manager parser here: How to Utilize Script Files with Steam ROM Manager to add it to Steam
Sonic 3 A.I.R.
Preface
To play Sonic 3 A.I.R., you will need an original and legal copy of Sonic 3 & Knuckles from the Steam version of Sonic 3 & Knuckles. This section will not cover how to obtain that file. For more information, see https://docs.google.com/document/d/1oSud8dJHvdfrYbkGCfllAOp3JuTks7z4K5SwtVkXkx0/edit#heading=h.ux87lw254eyd.
Sonic 3 A.I.R. has a comprehensive manual covering many of the features and settings in the game. See https://sonic3air.org/Manual.pdf.
What is Sonic 3 A.I.R.
A fan-made widescreen remaster of Sonic 3 & Knuckles.
Source: https://sonic3air.org/
Setting Up Sonic 3 A.I.R.
- In Desktop Mode, open Discover
- Search for Sonic 3: Angel Island Revisited
- Flathub page: https://flathub.org/apps/org.sonic3air.Sonic3AIR
- Discover (on the Steam Deck) uses Flathub as its source for applications
- Flathub page: https://flathub.org/apps/org.sonic3air.Sonic3AIR
- Download Sonic 3: Angel Island Revisited
- Open Sonic 3: Angel Island Revisited
- Select your
Sonic 3 & Knuckles
game file- The Steam version is typically named:
Sonic_Knuckles_wSonic3.bin
- For more information, read the Linux section on the manual: https://sonic3air.org/Manual.pdf
- The Steam version is typically named:
Sonic 3: Angel Island Revisited
Folder and File Locations
/home/deck/.var/app/org.sonic3air.Sonic3AIR
org.sonic3air.Sonic3AIR/
├── cache
├── config
└── data
└── Sonic3AIR
├── logfile.txt
├── mods
├── settings_input.json
├── settings.json
└── Sonic_Knuckles_wSonic3.bin
How to Configure Sonic 3 A.I.R.
- Open the
/home/deck/.var/app/org.sonic3air.Sonic3AIR/data/Sonic3AIR
folder~/.var
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, clickShow Hidden Files
to see these folders
- Right click
settings.json
orsettings_input.json
, clickOpen with Kate
or a text editor of your choicesettings.json
is specifically for game settingssettings_input.json
is specifically for game controls
- Customize settings
How to Mod Sonic 3 A.I.R.
Mod Resources
This list is not comprehensive
- Open the
/home/deck/.var/app/org.sonic3air.Sonic3AIR/data/Sonic3AIR
folder~/.var
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, clickShow Hidden Files
to see these folders
- Download and extract mod(s) to the
mod
folder- A mod folder should typically have a
Data
folder and amod.ini
file
- A mod folder should typically have a
- To activate/toggle the mod(s), open Sonic 3 A.I.R.. On the main menu, click the
Mods
button
How to add Sonic 3 A.I.R. to Steam
- Download attached
.sh
file - Place in
/home/deck/Applications
- Right click
Sonic3AIR.sh
- Click
Properties
- Click
Permissions
- Check
Is Executable
- Use
Sonic3AIR.sh
to open Sonic 3 A.I.R. - In Desktop Mode, right click
Sonic3AIR.sh
, clickAdd to Steam
- Alternatively, use the Steam ROM Manager parser here: How to Utilize Script Files with Steam ROM Manager to add it to Steam
How to Contribute to This Page
You will need to create a GitHub account first. To sign up for GitHub, see https://github.com/signup.
- Open https://github.com/EmuDeck/emudeck.github.io/blob/main/docs/community-creations/steamos/third-party-emulation.md
- Click the
Pencil
icon in the top right - Create a new section below the most recently added section under the respective category
- For example:
##### Paper Mario 64 Decompilation
- Make sure to add your section to the respective section in the Table of Contents as well
- For example:
- Write your section
- If you are using a Distrobox for your instructions, you may link to How to Set Up Distrobox
- If you are using external script files, embed them in code blocks instead
- Once you are finished making your changes, click the
Commit changes...
button in the top right - You will be prompted to create a Pull Request. Add a little bit of detail about what you added and why
- Submit your Pull Request
- Once your Pull Request is reviewed, it will be merged and any of your changes will automatically be deployed to this page