/EmuDeck-actions-test

Primary LanguageShellGNU General Public License v3.0GPL-3.0

EmuDeck

EmuDeck is a collection of scripts that allows you to autoconfigure your Steam Deck, it creates your roms directory structure and downloads all of the needed Emulators for you along with the best configurations for each of them. EmuDeck works great with Steam Rom Manager or with EmulationStation DE

** If you are a dev please read till the bottom **

There are two ways of using EmuDeck:

Using Steam Rom Manager

This option gives you all your games presented with their box arts as if they were a regular Steam Game. EmuDeck has preloaded configurations for Steam Rom Manager for the following systems:

System Emulator Roms format
Atari 2600 Retroarch Stella core .7z .a26 .bin .zip
Atari Lynx Retroarch Beetle Lynx core .7z .lnx .bin .zip
GameBoy Retroarch Gambatte core .7z .gb .dmg .zip
GameBoy Color Retroarch Gambatte core .7z .gb .gbc .dmg .zip
GameBoy Advance Retroarch mGBA core .7z .gba .zip
Dreamcast Retroarch FlyCast Core .7z .cdi .chd .cue .gdi
Final Burn Neo Retroarch Fbn core .zip .7z
Mame 2003 Plus Retroarch Mame 2003 Plus core .zip
Mame 2010 Retroarch Mame 2010 core .zip
Mame Current Retroarch Mame Current core .zip
Neo Geo Pocket & Color Retroarch Beetle NeoPop .7z .ngp .ngc .bin .zip
Nintendo GameCube Dolphin Standalone .ciso .dol .elf .gcm .gcz .iso .nkit .iso .rvz .wad .wia
Nintendo DS Retroarch melonDS core .7z .nds .zip
Nintendo 3DS Citra .3ds .3dsx .app .axf .cii .cxi .elf .cia
Nintendo NES Retroarch Nestopia core .7z .nes .fds .unf .unif .zip
Nintendo 64 Retroarch Mupen64plus-Next .7z .bin .n64 .ndd .u1 .v64 .z64 .zip
Nintendo GameCube Dolphin Standalone .ciso .dol .elf .gcm .gcz .iso .nkit .iso .rvz .wad .wia .wbfs
Nintendo Wii Dolphin Standalone .ciso .dol .elf .gcm .gcz .iso .json .nkit .iso .rvz .wad .wia .wbfs
Nintendo Wii U Cemu .rpx .wud .wux .elf .iso .wad
Nintendo Switch Yuzu .kp .nca .nro .nso .nsp .xci
Super Nintendo Retroarch Snes9x Current core .7z .bs .fig .sfc .smc .swx .zip
Super Nintendo Widescreen Retroarch bsnes hd beta Current core .7z .bs .fig .sfc .smc .swx .zip
PrimeHacks Dolphin PrimeHacks .ciso .dol .elf .gcm .gcz .iso .json .nkit .iso .rvz .wad .wia .wbfs
Playstation DuckStation .cue .chd .ecm .iso .m3u .mds .pbp
Playstation 2 RPCSX2 .bin .chd .cso .dump .gz .img .iso .mdf .nrg
Playstation 3 RPCS3 /PS3_GAME/USRDIR/eboot.bin
PSP PPSSPP & PPSSPP Retroarch core .7z .elf .cso .iso .pbp .prx
Sega 32X Retroarch PicoDrive core .7z .32x .bin .zip
Sega CD Retroarch Genesis Plus GX core .7z .32x .cue .chd .iso .zip
Sega Game Gear Retroarch Genesis Plus GX core .7z .gg .zip
Sega Genesis / Mega Drive Retroarch Genesis Plus GX core .7z .gen .md .smd .zip
Sega Genesis Widescreen Retroarch Genesis Plus GX Wide core .7z .gen .md .smd .zip
Sega Master System Retroarch Genesis Plus GX core .7z .gen .sms .zip
Sega Saturn Retroarch Yabause core .7z .cue .iso .chd .zip
Wonderswan & Color Retroarch Beetle Cygne core .7z .pc2 .ws .wsc .zip
Xbox xemu .iso (xiso format)

Using EmulationStation DE

EmuDeck configures EmulationStation DE to use the same rom folders that EmuDeck creates for you and it even downloads all the emulators and cores the ES-DE needs, all configurations that EmuDeck installs are carried over when using EmulationStation DE. For a comprehensive list of all the systems that ESDE supports go to ES-DE

Hotkeys

We try to use the same hotkeys for every emulator but some of them have their own different hotkeys, shown here:

 Hotkey RetroArch Dolphin Citra * Cemu * Yuzu PCSX2 * RPCS3
Menu L3 + R3 - - - - - -
Exit Select + Start Select + Start R5 Select + Start Select + Start STEAM Button STEAM Button
Pause/Unpause Emulation Select + A Select + A - - Select + A -
Fast Forward Select + R2 Select - - Select + R2 Select + R4 -
Load State Select + L1 Select + L1 - - - Select + L1 -
Save State Select + R1 Select + R1 - - - Select + R1 -
Full Screen - - L4 - - - -
Swap Screens - - R4 R4 - - -
Toggle Layout - - L5 - - - -

Note that Nintendo-oriented emulators refer to "A" in the emulated sense (physical Steam Deck "B") * You need to activate Steam Input to get those hotkeys to work https://www.emudeck.com/#steam_input

Developers, developers, developers.

If you wanna help us improve EmuDeck we are open to accept your PR! Just keep in mind this simple guide:

  • Think EmuDeck is for everybody, tech savvy and regular users, so everything has to be properly explained, use Easy mode for unattended automatic stuff.
  • User input is non recommended, everything should be done with no mouse or keyboard input. If input is a must then you have to code your feature only on expert mode.
  • Things using sudo are a big no no, there are exceptions but always try to find a way of prevent using sudo.
  • Every Emulator added has to be included on this readme file, have a SRM profile and follow the AmberElec hotkey mapping ( just check the previous table)
  • Always do your PR to the dev branch.