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 | ๐Ÿช„ Metadata | ๐Ÿš‘๏ธ Support

My main goal for emuze is to have a emulation launcher that is as fast and simple as possible. With this you don't have to configure every emulator and fine tune metadata of your roms. If your roms are named correctly, a click on the import button should import your emulators and roms altogether and therefore no configuration is necessary.

๐Ÿ’ฅ Features

  • โšก๏ธ Fast and responsive UI
  • ๐Ÿš‚ Import all your emulators and roms with a click of a button
  • ๐Ÿช„ Fetches Metadata from igdb based on the filenames of your roms
  • ๐ŸŽฎ๏ธ Gamepad support
  • ๐Ÿ’ป๏ธ Windows, Linux and Steam Deck support
  • ๐Ÿ”ง Can install missing emulators (Linux only)
  • ๐Ÿ’ซ Updates itself

Library

Library collapsed

๐Ÿ•น๏ธ Supported Systems

The following systems are supported:

System Emulator Pre Configured Bundled BIOS needed
Sega Master System ares Yes Yes No
Sega Game Gear ares Yes Yes No
Sega Mega Drive ares Yes Yes No
Sega 32X ares Yes Yes Yes
Sega CD ares Yes Yes Yes
Sega Saturn Mednafen Yes No Yes
Sega Dreamcast Flycast No No No
Nintendo Entertainment System ares Yes Yes No
Super Nintendo Entertainment System ares Yes Yes No
Nintendo Game Boy mgba No No No
Nintendo Game Boy Color mgba No No No
Nintendo Game Boy Advance mgba No No No
Nintendo DS MelonDS No No No
Nintendo 3DS Lime3DS No No No
Nintendo 64 ares Yes Yes No
Nintendo Gamecube Dolphin Yes Yes No
Nintendo Wii Dolphin Yes Yes No
Nintendo Wii U Cemu No No Yes
Nintendo Switch Ryujinx Yes Yes Yes
Sony PlayStation DuckStation (Legacy) Yes Yes Yes
Sony PlayStation 2 PCSX2 Yes No Yes
Sony PlayStation 3 RPCS3 No No Yes
Sony PlayStation Portable PPSSPP No No No
PC Engine ares Yes Yes No
PC Engine CD Mednafen Yes No Yes
PC Engine SuperGrafx Mednafen Yes No Yes
Arcade Mame No No No
Neo Geo Mame No No No
Neo Geo CD Mame No No No
Neo Geo Pocket ares Yes Yes Yes
Neo Geo Pocket Color ares Yes Yes Yes
Scumm ScummVM Yes No No
Dos (Supported Games) DOSBox-Staging No 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.

The following Hotkeys are set:

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

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
|-> ppsspp_win
|---> ...
|---> PPSSPPWindows64.exe
|---> ...
|-> mednafen-1.32.1-win64
|---> ...
|---> mednafen.exe
|---> ...

Linux

For now emuze is only released as an AppImage. Your Linux distribution needs to support Flatpaks. All emulators, not bundled, need to be installed via flatpak but emuze can do this for you.

  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. Add --no-sandbox as a launch option to the added Shortcut in Steam via Properties -> Shortcut -> LAUNCH OPTIONS.

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

Important

Steam Input can result in gamepads not being able to be used correctly in some emulators. Therefore, I recommend disabling Steam Input for all gamepads except the Steam Deck controller.

SteamGridDB

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

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

๐Ÿช„ Metadata

Metadata provides additional information about your games, e.g.

  • Cover art
  • Description
  • Genre
  • ...

Note

Right now, emuze only fetches Cover art for your games.

Metadata will be fetched from igdb. emuze crawls the name and alternative name of a game filtered by the specific system. The Search is case-insensitive.

Tip

igdb is a community driven open source database for game information. If there is something missing or wrong, please help and correct it there.

Games with a Subtitle

If a game has a subtitle, the subtitle needs to be in the file name.
For the title Max Payne 2 emuze wouldn't find metadata. Correct would be Max Payne 2: The Fall of Max Payne.chd.

On Windows special characters like : can't be part of a file name, therefore you have to write it the following: Max Payne 2 - The Fall of Max Payne.chd

Games with multiple Discs

If you have a game with multiple discs, like Final Fantasy VII, the file name for the first disc would be Final Fantasy VII (Disc 1).chd.

Games with multiple Versions (e.g. Regions)

If you have multiple versions of a game you can specify them in brackets, e.g. the file name for the japanese version of Castlevania would be Castlevania (J).nes.

๐Ÿ”ง Commandline Options

Usage: emuze [options]

Options:
  --help             Show help
  --fullscreen       Start the app in fullscreen mode
  --debugEmuze       Activates verbose logging to .emuze/emuze.log
  --rmgN64           Activates the less accurate Rosalies Mupen GUI (RMG) emulator to play N64
  --no-sandbox       Necessary if emuze is used as a non steam game (Steam Deck Game Mode)

๐Ÿš‘๏ธ Support

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