Skip to content

bmsuseluda/emuze

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

💥 Features | 🕹️ Supported Systems | 🚀 Getting Started | 🚑️ Support

emuze is an emulation frontend designed to simplify your retro gaming experience. It automates the configuration of each emulator, including seamless gamepad integration and automatic import of games along with their metadata. With its console-like interface and intuitive controls, emuze lets you focus on enjoying your retro games, just like you would on a gaming console.

It is not there yet for every system and emulator, please have a look at 🕹️ Supported Systems for more details.

💥 Features

  • ⚡️ Intuitive console-like interface
  • 🚂 Import all your roms with a click of a button
  • 🪄 Provides Metadata from igdb based on the filenames of your roms
  • 🎮️ Seamless gamepad integration for most emulators
  • 📦️ Bundles most emulators
  • 💻️ Windows, Linux and Steam Deck support
  • 💫 Updates itself

Library

Library collapsed

🕹️ Supported Systems

The following systems are supported:

System Emulator Pre Configured Bundled BIOS needed
Sega Master System ares Yes v145 No
Sega Game Gear ares Yes v145 No
Sega Mega Drive ares Yes v145 No
Sega 32X ares Yes v145 Yes
Sega CD ares Yes v145 Yes
Sega Saturn Mednafen Yes - Yes
Sega Dreamcast Flycast No - No
Nintendo Entertainment System ares Yes v145 No
Super Nintendo Entertainment System ares Yes v145 No
Nintendo Game Boy ares Yes v145 No
Nintendo Game Boy Color ares Yes v145 No
Nintendo Game Boy Advance ares Yes v145 Yes
Nintendo DS MelonDS No - No
Nintendo 3DS Azahar Yes v2122.1 No
Nintendo 64 ares Yes v145 No
Nintendo Gamecube Dolphin Yes v2506a No
Nintendo Wii Dolphin Yes v2506a No
Nintendo Wii U Cemu No - Yes
Nintendo Switch Ryujinx Yes v1.3.2 Yes
Sony PlayStation DuckStation (Legacy) Yes v0.1-7371 Yes
Sony PlayStation 2 PCSX2 Yes v2.4.0 Yes
Sony PlayStation 3 RPCS3 Yes v0.0.37 Yes
Sony PlayStation Portable PPSSPP Yes v1.19.3 No
PC Engine ares Yes v145 No
PC Engine CD Mednafen Yes - Yes
PC Engine SuperGrafx ares Yes v145 Yes
Arcade Mame No - No
Neo Geo Mame No - No
Neo Geo CD Mame No - No
Neo Geo Pocket ares Yes v145 Yes
Neo Geo Pocket Color ares Yes v145 Yes
Scumm ScummVM Yes - No
Dos (Supported Games) DOSBox-Staging No - No

Important

❤️ Many thanks to all emulator developers. Without you and your awesome work this wouldn't be possible.

Pre Configured

If a System is pre configured, all connected gamepads will be configured for the specific Emulator. If there are no gamepads connected, the keyboard will be configured instead.

Keyboard Mapping
Button Key
dpadUp T
dpadDown G
dpadLeft F
dpadRight H
a J
b K
x U
y I
back BACKSPACE
start RETURN
leftStick X
rightStick RSHIFT
leftShoulder L
rightShoulder O
leftTrigger 8
rightTrigger 9
leftStickUp W
leftStickDown S
leftStickLeft A
leftStickRight D
rightStickUp UP
rightStickDown DOWN
rightStickLeft LEFT
rightStickRight RIGHT

The following Hotkeys are set as well:

  • Open Emulator Menu (if supported from emulator): F2
  • Save State: F1
  • Load State: F3
  • Fullscreen: F11

You can close a game via

  • Xbox: back + a
  • PlayStation: select + x
  • Nintendo: select + a

Bundled

If a system is bundled, the respective emulator is provided with emuze in a specific version. Therefore you do not need to provide the emulator on your own.

BIOS needed

Some emulators need a BIOS or firmware to run. Please check the documentation of an emulator for more information.

🚀 Getting started

Windows

Download the latest Version of emuze and install it.

If you start emuze for the first time, it asks for the following folders to work:

You can change the folders in the settings.

Emulators Folder (Windows only)

This is the folder where your emulators are installed. It is only necessary on Windows and only for emulators not bundled by emuze.

emulators
|-> mame
|---> ...
|---> mame.exe
|---> ...
|-> mednafen-1.32.1-win64
|---> ...
|---> mednafen.exe
|---> ...

Linux

For now emuze is only released as an AppImage. All emulators, not bundled, need to be installed via flatpak.

  1. Download the latest Version of emuze

  2. Mark the AppImage as executable and start emuze

  3. Choose the folder where your Roms are located

Steam Deck in Game mode

For now emuze is only released as an AppImage.

  1. Switch to Desktop

  2. Download the latest Version of emuze

  3. Mark the AppImage as executable and start emuze

  4. Choose the folder where your Roms are located

  5. Add it via Add a Non-Steam Game to Steam and rename it to emuze

  6. Switch to Game Mode

Steam Input Profile

There is a Steam Input Profile with the name emuze, which has some Hotkeys pre configured on the back pedals of the Steam Deck.

  • L4: Save State
  • L5: Load State
  • R4: Open Emulator Menu (if supported from emulator) or Fullscreen
  • R5: Left Mouse Click
  • Right Trackpad: Mouse

SteamGridDB

There are several assets for emuze on SteamGridDB which you can use via the SteamGridDB Plugin in Decky Loader.

On an external Monitor / TV

If you use your Steam Deck on an external Monitor or TV I recommend switching to the native resolution via Properties -> Shortcut -> Game Resolution to Native.

Roms Folder

The Roms need to be grouped by their System. E.g. Final Fantasy VII.chd needs to be stored in a folder PlayStation.

roms
|-> PlayStation
|---> Tekken 2.chd
|---> Crash Bandicoot.chd
|---> Final Fantasy VII.chd
|---> ...
|-> Super Nintendo
|---> Super Metroid.sfc
|---> Terranigma.sfc
|---> ...

🔧 Commandline Options

Usage: emuze [options]

Options:
  --help             Show help
  --fullscreen       Start the app in fullscreen mode
  --debug-emuze      Activates verbose logging to /home/.local/share/emuze/emuze.log
  --rmg              Activates the less accurate Rosalies Mupen GUI (RMG) emulator to play N64
  --mgba             Activates the mgba emulator to play Game Boy
  --lime3ds          Activates the lime3DS emulator to play 3DS

🚑️ Support

If you have questions, found a bug or have a feature request, feel free to create an issue or join the Discord.

About

Launch your Retro Games fast and simple

Topics

Resources

License

Stars

Watchers

Forks

Languages