search

ryandavidmercado / emu-hub

A games-first hub for emulation.
GNU General Public License v3.0
113 stars 0 forks source link

readme

EmuHub

EmuHub Home EmuHub Game View EmuHub Store EmuHub All Games

emu(lator) | noun:

hardware or software that permits programs written for one computer to be run on another computer

hub | noun:

the effective center of an activity

Latest Release | Discord

Features

Initial Setup

  1. Download the latest release
    • Steam Deck: EmuHub...-x86_64.AppImage
    • Linux (x86/x64): EmuHub...-x86_64.AppImage
    • Linux (ARM 32-bit): EmuHub...armv7l.AppImage
    • Linux (ARM 64-bit): EmuHub...arm64.AppImage
    • MacOS: EmuHub...dmg
  2. (MacOS only) Open the DMG file and drag EmuHub.app onto the Installations folder.
  3. (Linux/Steam Deck only)
  4. Verify you've installed necessary emulators
    • The needed dependencies are listed below under Supported Systems. You only need one emulator for any system that lists multiple options.
    • If you're running on a Steam Deck with EmuDeck installed, this has already been taken care of for you. (DISCLAIMER: EmuHub is not affiliated with EmuDeck!)
    • If you're running on a Linux system with Flatpak, EmuHub can install emulators for you! Attempting to launch a game without the required emulator will prompt you to confirm the installation.
      • EmuHub will not configure the emulator for you yet! You might have to set up controls yourself, configure BIOS, etc. Consult the respective emulator's documentation if you run into any trouble.
      • MacOS support through Homebrew and Windows support through scoop for automatic emulator installation is on the roadmap but not yet implemented.
  5. Launch EmuHub
    • This will generate ROMs, assets, and config folders for you and guide you through initial setup
  6. Scrape games!
    1. Hit START to open the EmuHub menu
    2. Navigate to Games > Scrape Games > ScreenScraper Credentials
    3. Enter ScreenScraper username and password (optional but strongly recommended)
    4. Navigate back to Games > Scrape Games
    5. Hit Start Scraping to initiate scraping
  7. Explore!
    • Keep an eye on the Controller Hints in the footer; they'll guide you through navigation and sometimes signal features you might otherwise miss.
    • Check out Settings > Stores to download homebrew from EmuDeck (DISCLAIMER: EmuHub is not affiliated with EmuDeck!)
    • Select any game from the Home page to enter the Game View
    • Select Play on the Game View to launch
    • Select in the Game View to access game information and dynamic recommendations (by genre, developer, and publisher)
    • Select "Add to Collection" in the Game View to create your first collection!
      • Collections are great because they surface directly as scrollers on the Home Page
      • It has never been easier to access every Mario Kart in your collection.
    • Hit Select at any time to access the Navigation Menu
      • Home: The main screen; this is what you see when you launch EmuHub.
      • All Games: Self-explanatory. All games!
      • Search Games: Self-explanatory. Search your games collection!
    • Keep scraping as you add new games! The more you scrape, the better EmuHub will get.
      • EmuHub uses scraped data to surface per-game and general recommendations.
      • Powerful sorting and filtering tools are on the roadmap. The more data you have scraped, the easier it'll be to discover new games in your collection!

Supported Systems

Supported Platforms

Data Directories

Keyboard Mapping

When using a keyboard to navigate the interface, controls are mapped as follows:

Troubleshooting

EmuHub won't launch! (I'm on Steam Deck)

Make sure you've set the EmuHub AppImage to executable: https://docs.appimage.org/introduction/quickstart.html

If you're running EmuHub through Game Mode, add --no-sandbox to the launch options for EmuHub in Steam.

EmuHub said emulator not found when I tried to launch SOME GAME, but I have that emulator installed!

Please file an issue on this GitHub repository or leave a comment in your platform's support channel on our Discord.

RetroArch crashes when I run N64 games! (I'm on MacOS)

The default emulator for N64 (Mupen64Plus-Next) has some compatibility issues with non-Metal builds of RetroArch for MacOS. Either download the newest RetroArch nightly or set the default emulator for N64 to ParaLLEl (Settings -> Games -> Default Emulators -> Nintendo 64).

ADVANCED - Adding custom systems/emulators

EmuHub does not yet have a GUI for adding custom systems; you'll need to add these entries to the config files. (Alternatively, leave a comment in the #system-requests channel of our Discord so we can add the system to our roadmap!)

  1. Head to the EmuHub config directory for your respective platform (see: Data Directories)
  2. Open systems.yml
    • This file will be blank; this is expected! Default system entries can be referenced at EmuHubConfig/defaults/systems.yml.
  3. Add a new entry: 
    • - id: mycoolsystem # System ID shorthand; by default this will be used as the name of the ROMs directory.
ssId: 57 # Optional - ScreenScraper system ID. Including this improves scraping accuracy when scraping with ScreenScraper.
igdbId: 57 # Optional - ScreenScraper system ID. Including this improves scraping accuracy when scraping with IGDB.
handheld: true # Optional - Indicates that the system is a handheld.
name: My Cool System
emulators: # Correspond to IDs in emulators.yml. If you haven't made the necessary emulator entry yet, come up with an ID here and use it in the next step!
  - my_cool_system_emu
  - other_my_cool_system_emu
fileExtensions: # Files that don't match one of these extensions won't be included in the games list!
  - .someExt
  - .someOtherExt
releaseYear: "1999" # Optional
company: SystemBoys # Optional
defaultNames: # ADVANCED - Optional - used for defining default name logic per-file extension. If unspecified, default game names are derived from the file name. Useful for NAND-based systems like PS3 and Vita.
  .someExt:
    type: pathToken # Only supported type currently; defines default name as a function of relative path
    token: -2 # For use with type pathToken. If a ROM is located at games/My Cool Game/GAME_DATA/data.someExt, -2 gives us "My Cool Name" as the default name. -1 would give us "GAME_DATA".
    map: mycoolsystemmap # Optional - Not useful for custom systems since maps currently aren't user-configurable. Maps the name derived from the pathToken to some other game given by the EmuHub-defined map. Used for mapping PS3 and Vita TITLEIDs to actual game names.
stores: # ADVANCED - Optional - Defines content repositories for the system. Used for downloading games in EmuHub.
  - type: emudeck # Used for EmuDeck stores. Only functions if EmuDeck has homebrew available for the given system.
    name: EmuDeck
    id: emudeck
  - type: html # Used for web-based stores. html stores expect a URL with some list of links to downloadable content. Pagination is not currently supported.
    name: My HTML Store
    id: myhtmlstore
    url: http://some-homebrew-repo.com/mycoolsystem/games
    selector: "#gamesList tr > .link > a" # CSS selector for grabbing the relevant links from the page. This is just an example; this needs to be sorted out for whatever page is being used.
romdir: path/to/roms # Optional - Used for overriding the ROMs directory for this system. Default ROMs directory is [EMUHUB-ROMS-DIRECTORY]/[System ID]
    • Partial entries can be used to extend default systems. For example, to add .someObscureExt to our PS1 file extensions: 
      • - id: psx
fileExtensions:
  - .someObscureExt
  4. Open emulators.yml
    • This file will be blank; this is expected! Default emulator entries can be referenced (but not modified) at EmuHubConfig/defaults/emulators.yml.
  5. Add a new entry: 
    • - id: my_cool_system_emu # This should correspond to the emulator you entered in systems.yml!
name: My Cool System Emu
args: # Optional - Specifies arguments that should be inserted after the path to the emulator and before the path to the game file when launching a game.
  - -f # Example fullscreen argument
launchCommand: `%EMUPATH% --game="%ROMPATH%"` # Optional - Can be used instead of args to define a more custom-tailored launch command. See below for available argument tokens (%EMUPATH%, etc.)
launchCommands: # Optional - Same as launchCommand but defined per-file extension. Useful if some files need to be launched differently than other files.
  .someExt: `%EMUPATH% -abc "%ROMNAMENOEXT%"`
  .someOtherExt: `%EMUPATH% -def "%ROMPATH%"`
location:
  core: core_name # Use this if your emulator is a RetroArch core. Should correspond to the core's filename, minus the extension (check RetroArch's Cores directory to find this)
  bin: /path/to/emulator.AppImage # Use this if your emulator is not a RetroArch core. AppImage is only an example here; this should be whatever actual executable is used to launch the emulator (.exe, no extension at all, etc)
    • The following argument tokens are supported when using launchCommand or launchCommands:
      • %EMUPATH% - example: "/home/Applications/CoolEmu.AppImage"
        • For technical reaons, %EMUPATH% is escaped with strings automatically. This is not true for any other argument token!
      • %ROMPATH% - example: /path/to/roms/someSystem/someParentDir/myRom.rom
      • %ROMDIR% - example: /path/to/roms/someSystem/someParentDir
      • %ROMDIRNAME% - example: someParentDir
      • %ROMNAME% - example: myRom.rom
      • %ROMNAMENOEXT% - example: myRom
      • %ROMEXT% - example: .rom
      • %ROMTEXTCONTENT% - example: rom is a text file with contents "Hello". %ROMTEXTCONTENT% is replaced with "Hello"
        • Double-check to make sure you need this if you're using it! Using %ROMTEXTCONTENT% on a ROM that isn't actually a text file will lead to headaches, crashes, crying and also frustration.
    • Partial entries can be used to extend default systems. For example, if I have DuckStation in some exotic location that EmuHub can't automatically find:
      • id: duckstation location: bin: /my/super/exotic/path/to/duckstation/DuckStation.exe