Skip to content

Third Party Emulation

Jump to bottom Edit New page
rawdatafeel edited this page Nov 13, 2023 · 56 revisions

THIS WIKI IS NO LONGER MAINTAINED. VISIT https://emudeck.github.io/ FOR THE NEW EMUDECK WIKI.

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

  1. Decompilations and Reverse Engineered PC Ports

  2. Emulators

  3. Emulation Related Games

Decompilations and Reverse Engineered PC Ports

Back to the Top

Getting Started with Decompilations and Reverse Engineered PC Ports

Back to the Top

How to Set up Distrobox

Back to the Top

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

  1. In Desktop Mode, open Konsole, type in passwd, and press enter
  2. 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
  3. Exit out of Konsole

How to Install Distrobox

This will require your sudo password for the setup

  1. In Desktop Mode, open Konsole and enter the following two lines, one at a time
curl -s https://raw.githubusercontent.com/89luca89/distrobox/main/install | sh -s -- --prefix ~/.local

curl -s https://raw.githubusercontent.com/89luca89/distrobox/main/extras/install-podman | sh -s -- --prefix ~/.local

How to Configure bashrc

  1. In Desktop Mode, open the /home/deck folder
    • You may not see the word deck in the file path at the top, this is the home folder for the deck user
  2. Click the hamburger menu in the top right, ☰, click Show Hidden Files
  3. Right click .bashrc, click Open with Kate or a file editor of your choice
  4. Add these three lines to the bottom of the .bashrc file
# Uncomment the line below if you know that you are using xhost
#xhost +si:localuser:$USER
export PATH=$PATH:$HOME/.local/bin
export PATH=$PATH:$HOME/.local/podman/bin
  1. Save the .bashrc file and exit
  2. 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

  1. Open Konsole
  2. Create an Ubuntu distrobox: distrobox create --name ubuntu -i ubuntu:22.10
  3. Type in y to confirm and press enter
  4. Press enter on the docker.io... line, typically the first line
  5. 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

Games

Back to the Top

Cannonball - OutRun Engine

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. 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.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone --recursive https://github.com/djyt/cannonball.git
  3. A cannonball folder will be created, `
  4. You will add your ROM files will be added after the build is finished

Building Cannonball

  1. In /home/deck/Applications/Distrobox/cannonball, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. 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
  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

Back to the Top

What is OpenGOAL?

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.

  1. In /home/deck/Applications, create an OpenGOAL folder
  2. Download the latest tar.gz from here: https://github.com/open-goal/jak-project/releases/tag/v0.1.32 and place it in the folder you created in Step 1
    • Example: Download opengoal-linux-v0.1.32.tar.gz
      • The version number may be different depending on when you are reading this
  3. Right click the tar.gz file and click Extract archive here
    • This will make it easier to apply updates. When an update is released, you can overwrite the files in this directory
  4. Place your Jak and Daxter: The Precursor Legacy in /home/deck/Applications/OpenGOAL
    • If you use EmuDeck, you may also place it in Emulation/roms/ps2

Installing OpenGOAL

  1. In /home/deck/Applications/OpenGOAL, right click, click Open Terminal Here
  2. Enter: ./extractor "NAMEOFJAKANDDEXTERROM"
    • If you have spaces, you will need to use quotes around the ROM name
    • If you placed your ROM in another directory, you will need to enter the full path
      • Example: If you placed it in your Emulation/roms/ps2 folder on your SD card, the command will look like the following: ./extractor "/run/media/mmcblk0p1/Emulation/roms/ps2/NAMEOFJAKANDDEXTERROM"
  3. To play Jak and Daxter: The Precursor Legacy, open /home/deck/Applications/OpenGOAL/gk

How to Install Custom Textures

Note: After placing your custom textures, you will need to run the extractor again, some steps will be identical to the previous section.

  1. Download the custom textures from the pinned comment on this Youtube Video: https://www.youtube.com/watch?v=lX1gBO1INZ4 to your /home/deck/Downloads folder
  2. Right click texture_replacements.zip and click Extract archive here, autodetect subfolder
  3. Move the extracted texture_replacements folder to /home/deck/Applications/OpenGOAL/data
  4. In /home/deck/Applications/OpenGOAL, right click, click Open Terminal Here
  5. Enter: ./extractor "NAMEOFJAKANDDEXTERROM"
    • If you have spaces, you will need to use quotes around the ROM name
    • If you placed your ROM in another directory, you will need to enter the full path
      • Example: If you placed it in your Emulation/roms/ps2 folder on your SD card, the command will look like the following: ./extractor "/run/media/mmcblk0p1/Emulation/roms/ps2/NAMEOFJAKANDDEXTERROM"
  6. Wait
  7. Your custom textures will now be installed

Render96ex

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. 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.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone --single-branch --branch alpha https://github.com/Render96/Render96ex.git
  3. A Render96ex folder will be created, place your Super Mario 64 ROM in this folder
  4. Rename the Super Mario 64 ROM to baserom.us.z64

Building Render96ex

  1. In /home/deck/Applications/Distrobox/Render96ex/, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make -j4 TEXTURE_FIX=1
  3. Wait for it to finish building
  4. To play Render96ex, open sm64.us.f3dex2e in /home/deck/Applications/Distrobox/Render96ex/build/us_pc

How to Install Custom Models

  1. Download the latest model pack: https://github.com/Render96/ModelPack/releases to /home/deck/Downloads
  2. Right click Render96_DynOs_v3.2.7z and click Extract archive here, autodetect subfolder
  3. Move the newly extracted Render96_DynOs... folder to /home/deck/Applications/Distrobox/Render96ex/build/us_pc/dynos/packs
  4. To enable custom models, in game, press Start, press L2, select Model Packs and enable Render96DynOs...

How to Install Custom Textures

  1. In /home/deck/Applications/Distrobox/Render96ex/, right click Open Terminal Here, enter:
    • git clone https://github.com/pokeheadroom/RENDER96-HD-TEXTURE-PACK.git -b master
  2. Move the gfx folder in the newly cloned RENDER96-HD-TEXTURE-PACK folder to /home/deck/Applications/Distrobox/Render96ex/build/us_pc/res

How to Configure Render96ex

  1. While in game, press Start, press R1
  2. Configure settings

Ship of Harkinian: Ocarina of Time

Back to the Top

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

Build team: `zelda@srd022j`
Build date: `03-02-21 00:49:18` (year-month-day)
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099

Ocarina of Time PAL GameCube

May lead to crashes and instability

sha1: 0227d7c0074f2d0ac935631990da8ec5914597b4

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.

  1. In /home/deck/Applications, create a ShipofHarkinian folder
  2. Download the latest version of Ship of Harkinian: https://www.shipofharkinian.com/ to the folder you created in Step 1
    • Download links are only available from their Discord
    • Download the Linux / SteamDeck (Perfomance Build)
  3. Right click the downloaded zip file and click Extract archive here, detect subfolder
  4. Move the soh.AppImage to /home/deck/Applications/ShipofHarkinian
  5. Right click soh.AppImage, click Properties, click Permissions, check Is Executable

Installing Ship of Harkinian

  1. Place your The Legend of Zelda: Ocarina of Time ROM in /home/deck/Applications/ShipofHarkinian
  2. Open soh.AppImage, wait
  3. 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

  1. 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
  2. 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
  3. 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

Super Mario 64 Plus

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. 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.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone https://github.com/MorsGames/sm64plus
  3. A sm64plus folder will be created, place your Super Mario 64 ROM in this folder
  4. Rename the Super Mario 64 ROM to baserom.us.z64

Building Super Mario 64 Plus

  1. In /home/deck/Applications/Distrobox/sm64plus/, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make -j4
  3. Wait for it to finish building
  4. 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

  1. Download attached .sh file
  2. Place in /home/deck/Applications
  3. Right click SuperMario64Plus.sh
  4. Click Properties
  5. Click Permissions
  6. Check Is Executable
  7. Use SuperMario64Plus.sh to open SM64Plus

How to Configure Super Mario 64 Plus

  1. Open sm64.us in /home/deck/Applications/Distrobox/sm64plus/build/us_pc at least once so it can generate the settings.ini file
  2. Open the /home/deck/Applications/Distrobox/sm64plus/build/us_pc folder
  3. Right click settings.ini, click Open with Kate or a text editor of your choice
  4. Customize settings

Recommended Settings

  • Set window_height to 800

How to Add Super Mario 64 Plus to Steam

  1. In /home/deck/Applications, right click SuperMario64Plus.sh, click Add to Steam
  2. After adding it to Steam, you may rename the shortcut in Steam directly

Super Mario Bros

Back to the Top

How to Compile Super Mario Bros on the Steam Deck

Note: This section requires a legal copy of a Super Mario All-Stars ROM for the SNES.

What is this?

A reverse engineered clone of Super Mario Bros.

Source: https://github.com/snesrev/smw/tree/smb1

Installing Prerequisites

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following commands one at a time:
    • sudo apt install libsdl2-dev python3-pip make
    • python3 -m pip install --upgrade pip pillow pyyaml zstandard

How to Set Up Super Mario Bros

Note: The following folder locations are recommendations. You may choose a different folder location.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone https://github.com/snesrev/smw.git smb1 -b smb1 --single-branch
  3. A smb1 folder will be created, place your Super Mario All-Stars ROM in /home/deck/Applications/smb1/other
    • SHA256 Hash: c05817c5b7df2fbfe631563e0b37237156a8f6b6
    • To locate your SHA256 Hash, right click your ROM, click Properties, click Checksums, click Calculate to the left of SHA1 and compare it to the above hash. If it is a match, you have a valid ROM
  4. Rename the Super Mario World ROM to smas.sfc

How to Build Super Mario Bros

  1. In /home/deck/Applications/Distrobox/smb1/other, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • python3 extract_smb1.py
  3. 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
  4. Enter:
    • make
  5. Wait for it to finish building

How to Play Super Mario Bros

  1. Download attached .sh file
  2. Place in /home/deck/Applications
  3. Right click smb1.sh
  4. Click Properties
  5. Click Permissions
  6. Check Is Executable
  7. Use smb1.sh to open Super Mario Bros

How to Configure Super Mario Bros

  1. In /home/deck/Applications/Distrobox/smb1/, right click smw.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

Recommended

  • Set Fullscreen to 1

Super Mario Bros: The Lost Levels

Back to the Top

How to Compile Super Mario Bros: The Lost Levels on the Steam Deck

Note: This section requires a legal copy of a Super Mario All-Stars ROM 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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following commands one at a time:
    • sudo apt install libsdl2-dev python3-pip make
    • python3 -m pip install --upgrade pip pillow pyyaml 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.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone https://github.com/snesrev/smw.git smbll -b smb1 --single-branch
  3. A smbll folder will be created, place your Super Mario All-Stars ROM in /home/deck/Applications/smbll/other
    • SHA256 Hash: c05817c5b7df2fbfe631563e0b37237156a8f6b6
    • To locate your SHA256 Hash, right click your ROM, click Properties, click Checksums, click Calculate to the left of SHA1 and compare it to the above hash. If it is a match, you have a valid ROM
  4. Rename the Super Mario World ROM to smas.sfc

How to Build Super Mario Bros: The Lost Levels

  1. In /home/deck/Applications/Distrobox/smbll/other, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • python3 extract.py
  3. 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
  4. Enter:
    • make
  5. Wait for it to finish building

How to Play Super Mario Bros: The Lost Levels

  1. Download attached .sh file
  2. Place in /home/deck/Applications
  3. Right click smbll.sh
  4. Click Properties
  5. Click Permissions
  6. Check Is Executable
  7. Use smbll.sh to open Super Mario Bros: The Lost Levels

How to Configure Super Mario Bros: The Lost Levels

  1. In /home/deck/Applications/Distrobox/smbll/, right click smw.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

Recommended

  • Set Fullscreen to 1

Super Mario World

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following commands one at a time:
    • sudo apt install libsdl2-dev python3-pip make
    • python3 -m pip install --upgrade pip pillow pyyaml

How to Set Up Super Mario World

Note: The following folder locations are recommendations. You may choose a different folder location.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone https://github.com/snesrev/smw
  3. 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, click Checksums, click Calculate to the left of SHA1 and compare it to the above hash. If it is a match, you have a valid ROM
  4. Rename the Super Mario World ROM to smw.sfc

How to Build Super Mario World

  1. In /home/deck/Applications/Distrobox/smw/, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make
  3. Wait for it to finish building
  4. To play Super Mario World, open smw in /home/deck/Applications/Distrobox/smw/

How to Configure Super Mario World

  1. In /home/deck/Applications/Distrobox/smw/, right click smw.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

Recommended

  • Set Fullscreen to 1

Super Metroid

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following:
    • sudo apt install libsdl2-dev python3-pip make

Setting Up Super Metroid

Note: The following folder locations are recommendations. You may choose a different folder location.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone --recursive https://github.com/snesrev/sm
  3. A sm folder will be created, place your US Super Metroid ROM in /home/deck/Applications/sm
  4. Rename the Super Metroid ROM to sm.smc

Building Super Metroid

  1. In /home/deck/Applications/Distrobox/sm, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make
  3. Wait for it to finish building
  4. To play Super Metroid, open sm in /home/deck/Applications/Distrobox/sm/

How to Configure Super Metroid

  1. In /home/deck/Applications/Distrobox/sm/, right click sm.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

Super Metroid Redux

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following:
    • sudo apt install libsdl2-dev python3-pip make

Patching Super Metroid Redux

  1. Download the patch here: https://www.romhacking.net/hacks/4963/
  2. 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.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone --recursive https://github.com/testyourmine/sm-redux
  3. A sm-redux folder will be created, place your patched US Super Metroid ROM in /home/deck/Applications/sm-redux
  4. Rename the patched Super Metroid ROM to sm.smc

Building Super Metroid Redux

  1. In /home/deck/Applications/Distrobox/sm-redux, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make
  3. Wait for it to finish building
  4. To play Super Metroid Redux, open sm in /home/deck/Applications/Distrobox/sm-redux/

How to Configure Super Metroid Redux

  1. In /home/deck/Applications/Distrobox/sm-redux/, right click sm.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

zelda3: A Link to the Past

Back to the Top

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

  1. Set up a Distrobox
  2. Enter the distrobox by opening Konsole and entering: distrobox enter ubuntu
  3. Enter the following commands one at a time:
    • sudo apt install libsdl2-dev python3-pip make
    • python3 -m pip install --upgrade pip pillow pyyaml

How to Set Up zelda3

Note: The following folder locations are recommendations. You may choose a different folder location.

  1. In /home/deck/Applications, create a Distrobox folder
  2. In the Distrobox folder, right click Open Terminal Here, enter:
    • git clone https://github.com/snesrev/zelda3
  3. A zelda3 folder will be created, place your US Link to the Past ROM in /home/deck/Applications/zelda3/tables
    • SHA256 Hash: 66871d66be19ad2c34c927d6b14cd8eb6fc3181965b6e517cb361f7316009cfb
    • To locate your SHA256 Hash, right click your ROM, click Properties, click Checksums, click Calculate to the left of SHA1 and compare it to the above hash. If it is a match, you have a valid ROM
  4. Rename the Link to the Past ROM to zelda3.sfc

How to Build zelda3

  1. In /home/deck/Applications/Distrobox/zelda3/, right click Open Terminal Here, enter:
    • distrobox enter ubuntu
  2. Enter:
    • make
  3. Wait for it to finish building
  4. To play zelda3, open zelda3 in /home/deck/Applications/Distrobox/zelda3/

How to Configure zelda3

  1. In /home/deck/Applications/Distrobox/zelda3/, right click zelda3.ini, click Open with Kate or a text editor of your choice
  2. Customize settings

Recommended

  • Set ExtendedAspectRatio to 16:10
  • Set Fullscreen to 1

How to Customize Sprites

  1. In /home/deck/Applications/Distrobox/zelda3/, right click Open Terminal Here, enter:
    • git clone --recursive https://github.com/snesrev/sprites-gfx.git
  2. In /home/deck/Applications/Distrobox/zelda3/, right click zelda3.ini, click Open with Kate or a text editor of your choice
  3. Remove the # at the beginning of this line: # LinkGraphics = sprites-gfx/snes/zelda3/link/sheets/megaman-x.2.zspr
  4. 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

  1. On http://alttp.mymm1.com/sprites/, right click the link above the sprite you would like to use, click Copy Link
  2. In a new tab, paste the URL
    • If you press enter, it will download the sprite
  3. The sprite file name will be at the end of the URL
  4. Example (Crewmate): https://alttpr-assets.s3.us-east-2.amazonaws.com/crewmate.2.zspr
  5. In zelda3.ini, replace megaman-x.2.zspr at the end: LinkGraphics = sprites-gfx/snes/zelda3/link/sheets/megaman-x.2.zspr with crewmate2.zspr
  6. 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

  1. 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
  2. Right click Zelda Alternative Soundtrack by JUD6MENT (update Sep-21-2021).zip, click Extract archive here, autodetect subfolder
  3. Rename the newly extracted Zelda Alternative Soundtrack by JUD6MENT (update Sep-21-2021) folder to msu
    • msu is case sensitive
  4. Move the msu folder to /home/deck/Applications/Distrobox/zelda3/
  5. In /home/deck/Applications/Distrobox/zelda3/, right click zelda3.ini, click Open with Kate or a text editor of your choice
  6. Edit the line: EnableMSU = false so it instead writes: EnableMSU = true
  7. MSU1 CD Soundtrack Files are now enabled

General Maintenance

Back to the Top

How to Add Decompilations and Reverse Engineered PC Ports to Steam

Back to the Top

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

Here's How:

For the following games:

  1. 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: Super Metroid.sh or The Legend of Zelda: A Link to the Past.sh
  2. Open the text file in a text editor of your choice
  3. Enter the following: 
    #!/bin/sh
cd /path/to/game"
"/path/to/gameexecutable"
  4. 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 the following games:

  1. Download attached .sh file
  2. Place in /home/deck/Applications
  3. Right click SuperMario64Plus.sh
  4. Click Properties
  5. Click Permissions
  6. Check Is Executable
  7. Use SuperMario64Plus.sh to open SM64Plus
  8. In Desktop Mode, right click SuperMario64Plus.sh, click Add to Steam

For the following games:

  1. 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 or Jak and Dexter: The Precursor Legacy
  2. Open the text file in a text editor of your choice
  3. Enter the following: 
    #!/bin/sh
"/path/to/gameexecutable"
  4. Edit the path to where your game executable is located

For example:

#!/bin/sh
"/home/deck/Applications/OpenGoal/gk"

How to Utilize Script Files with EmulationStation-DE

  1. Place your script files in Emulation/roms/desktop
  2. In Game Mode, open EmulationStation-DE and play your newly created script files

How to Utilize Script Files with Steam ROM Manager

  1. Place your script files in Emulation/roms/desktop
  2. In /home/deck/.config/steam-rom-manager/userData/, open userConfigurations.json in a text editor of your choice
  3. Scroll to the very bottom of the text file, you will see a } and a ], add a comma to }
  4. 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
}
  5. 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

This section specifically applies to:

  1. In the respective folder, open a terminal and enter:
    • git pull origin main
    • If this does not work, try:
      • git pull origin master
  2. 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
  3. Rebuild the game
    • You may reference the various sections to re-build the game. The steps will be identical

Emulators

Back to the Top

BlueMaxima's Flashpoint

Back to the Top

Link: https://gist.github.com/parkerlreed/4bd1f5fa38f7ffa72f9ceacb7d7f636d

Hypseus Singe

Back to the Top

Link: https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#hypseus-singe-daphne

Supermodel: Model 3 Emulator

Back to the Top

Note: The following folder locations are required so EmulationStation-DE can properly recognize the emulator and your ROMs.

Prerequisites:

  • EmulationStation-DE 2.0

Setting up Supermodel

  1. Download Supermodel from: https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE-DEV.md#arcade-and-neo-geo, under Sega Model 3 to your /home/deck/Downloads folder
  2. Right click Supermodel_2022-10-07.tar.gz, click Extract > Extract archive here
  3. Move the Config and NVRAM folders from the extracted folder in Step 2 to Emulation/roms/model3
  4. In /home/deck/Applications, create a Supermodel folder
  5. Move the supermodel file from the extracted folder in Step 2 to /home/deck/Applications/Supermodel

Running Supermodel

  1. 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

Super Smash Bros: Project+

Back to the Top

Link: https://gist.github.com/WingofaGriffin/3202698447ca2452a9431137cfc18d21

Emulation Related Games

Back to the Top

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

  1. In Desktop Mode, open Discover
  2. Search for AM2R
  3. Download AM2R
  4. Open AM2R and click the big Download button on the main screen
  5. Select Select AM2R_1_1.zip, select your file, and play the game

PokeMMO

Back to the Top

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.

  1. In /home/deck/Games, create a PokeMMO folder
  2. In /home/deck/Games/PokeMMO, create a jdk folder
  3. Download Java OpenJDK: https://jdk.java.net/19/ to /home/deck/Games/PokeMMO
    • Download Linux / x64 tar.gz (sha256) 195931906
  4. Download PokeMMO: https://pokemmo.com/downloads/linux/ to /home/deck/Games/PokeMMO
    • Under Other Distributions, click Download the Client
  5. Extract PokeMMO-Client.zip in /home/deck/Games/PokeMMO
  6. Extract openjdk-19.0.2_linux-x64_bin.tar.gz to /home/deck/Games/PokeMMO/jdk
    • If the .tar.gz creates a subfolder, move the contents out directly into /home/deck/Games/PokeMMO/jdk
  7. 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

  1. Download attached .sh file
  2. Place in /home/deck/Applications
  3. Right click PokeMMO.sh
  4. Click Properties
  5. Click Permissions
  6. Check Is Executable
  7. Use PokeMMO.sh to open SM64Plus
  8. In Desktop Mode, right click PokeMMO.sh, click Add to Steam
Add a custom footer
Clone this wiki locally