Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature] Folder Mapping for ES-DE's structure #892

Closed
DarkSirrush opened this issue May 28, 2024 · 3 comments
Closed

[Feature] Folder Mapping for ES-DE's structure #892

DarkSirrush opened this issue May 28, 2024 · 3 comments
Labels
feature New feature or request

Comments

@DarkSirrush
Copy link

Is your feature request related to a problem? Please describe.

An example config to remap the folder structure to match how Emudeck/ES-DE structures it

Describe the solution you'd like

# This is an example of a RomM configuration file
# You can copy this file to a folder, rename it to 'config.yml', and mount it as per the example docker-compose.yml
# Uncomment the lines you want to use and modify the values to your needs

exclude:
  # Exclude platforms to be scanned
  platforms:
    - 'romm'

  # Exclude roms or parts of roms to be scanned
  roms:

    ## Single file games section.
    # Will not apply to files that are in sub-folders (multi-disc roms, games with updates, DLC, patches, etc.)
    single_file:
      # Exclude all files with certain extensions to be scanned
      extensions:
        - 'xml'
        - 'txt'
      # Exclude matched file names to be scanned
      names:
        - 'roms'
        - 'pfx'
        - 'info.txt'
        - '._*' # Supports unix filename pattern matching
        - '*.nfo' # Can also exclude files by extension
        - 'metadata.txt'
        - 'systeminfo.txt'

    ## Multi files games section
    # Will apply to files that are in sub-folders (multi-disc roms, games with updates, DLC, patches, etc.)
    multi_file:
      # Exclude matched 'folder' names to be scanned (RomM identifies folders as multi file games)
      names:
        # - 'my_multi_file_game'
        - 'DLC'
      # Exclude files within sub-folders.
      parts:
        # Exclude matched file names to be scanned from multi file roms
        # Keep in mind that RomM doesn't scan folders inside multi files games,
        # so there is no need to exclude folders from inside of multi files games.
        names:
          - 'data.xml'
          - '._*' # Supports unix filename pattern matching
        # Exclude all files with certain extensions to be scanned from multi file roms
        extensions:
          - 'txt'

system:
  # Asociate different platform names to your current file system platform names
  platforms:
    # [your custom platform folder name]: [RomM platform name]
    3do: '3do' # 3DO Interactive Multiplayer
    n3ds: '3ds' # Nintendo 3DS
    amstradcpc: 'acpc' # Amstrad CPC
    amiga: 'amiga' # Amiga
    amigacd32: 'amiga-cd32' # Amiga CD32
    android: 'android' # Android
    apple2gs: 'apple2gs' # Apple IIGD
    apple2: 'appleii' # Apple II
    arcade: 'arcade' # Arcade
    arcadia: 'arcadia-2001' # Arcadia 2001
    arduboy: 'arduboy' # Arduboy
    astrocde: 'astrocade' # Bally Astrocade
    atarijaguarcd: 'atari-jaguar-cd' # Atari Jaguar CD
    atarist: 'atari-st' # Atari ST/STE
    atari2600: 'atari2600' # Atari 2600
    atari5200: 'atari5200' # Atari 5200
    atari7800: 'atari7800' # Atari 7800
    atari800: 'atari8bit' # Atari 8-bit
    c16: 'c16' # Commodore 16
    c64: 'c64' # Commodore C64/128/MAX
    pv1000: 'casio-pv-1000' # Casio PV-1000
    colecovision: 'colecovision' # ColecoVision
    cdtv: 'commodore-cdtv' # CDTV
    crvision: 'creativision' # CreatiVision
    dreamcast: 'dc' # Dreamcast
    dos: 'dos' # DOS
    dragon32: 'dragon-32-slash-64' # Dragon 32/64
    channelf: 'fairchild-channel-f' # Channel F
    famicom: 'famicom' # Family Computer
    fds: 'fds' # Family Computer Disk System
    fmtowns: 'fm-towns' # FM Towns
    gameandwatch: 'g-and-w' # Game & Watch
    gamecom: 'game-dot-com' # Game.Com
    gb: 'gb' # Game Boy
    gba: 'gba' # Game Boy Advance
    gbc: 'gbc' # Game Boy Color
    megadrive: 'genesis-slash-megadrive' # Genesis/Mega Drive
    lcdgames: 'handheld-electronic-lcd' # Handheld Electronic LCD
    intellivision: 'intellivision' # Intellivision
    j2me: 'j2me' # J2ME
    atarijaguar: 'jaguar' # Atari Jaguar
    atarilynx: 'lynx' # Atari Lynx
    macintosh: 'mac' # Mac
    megaduck: 'mega-duck-slash-cougar-boy' # Mega Duck/Cougar Boy
    msx: 'msx' # MSX
    msx2: 'msx2' # MSX2
    n64: 'n64' # Nintendo 64
    nds: 'nds' # Nintendo DS
    neogeocd: 'neo-geo-cd' # Neo Geo CD
    ngp: 'neo-geo-pocket' # Neo Geo Pocket
    ngpc: 'neo-geo-pocket-color' # Neo Geo Pocket Color
    neogeo: 'neogeoaes' # Neo Geo
    nes: 'nes' # Nintendo Entertainment System
    gc: 'ngc' # GameCube
    n64dd: 'nintendo-64dd' # Nintendo 64DD
    odyssey2: 'odyssey-2-slash-videopac-g7000' # Odyssey 2/Videopac G7000
    oric: 'oric' # Oric
    palm: 'palm-os' # Palm OS
    pc88: 'pc-8800-series' # PC-8800 Series
    pc98: 'pc-9800-series' # PC-9800 Series
    pcfx: 'pc-fx' # PC-FX
    pokemini: 'pokemon-mini' # Pokémon mini
    psx: 'ps' # PlayStation
    ps2: 'ps2' # PlayStation 2
    ps3: 'ps3' # PlayStation 3
    ps4: 'ps4--1' # PlayStation 4
    psp: 'psp' # PlayStation Portable
    samcoupe: 'sam-coupe' # SAM Coupé
    satellaview: 'satellaview' # Satellaview
    sega32x: 'sega-32x' # SEGA 32X
    mastersystem: 'sega-master-system' # SEGA Master System
    sega32x: 'sega32' # Sega 32X
    megacd: 'segacd' # SEGA CD
    sfc: 'sfam' # Super Famicom
    sg-1000: 'sg1000' # SG-1000
    x68000: 'sharp-x68000' # Sharp X68000
    snes: 'snes' # Super Nintendo Entertainment System
    spectravideo: 'spectravideo' # Spectravideo
    supergrafx: 'supergrafx' # PC Engine SuperGrafx
    supervision: 'supervision' # Supervision
    switch: 'switch' # Nintendo Switch
    symbian: 'symbian' # Symbian
    ti99: 'ti-99' # Texas Instruments TI-99
    trs-80: 'trs-80' # TRS-80
    tg-cd: 'turbografx-16-slash-pc-engine-cd' # TurboGrafx CD
    tg16: 'turbografx16--1' # TurboGrafx-16
    vectrex: 'vectrex' # Vectrex
    vic20: 'vic-20' # Commodore VIC-20
    videopac: 'videopac-g7400' # Videopac+ G7400
    virtualboy: 'virtualboy' # Virtual Boy
    vsmile: 'vsmile' # V.Smile
    wii: 'wii' # Wii
    wiiu: 'wiiu' # Wii U
    pc: 'win' # PC (Microsoft Windows)
    wonderswan: 'wonderswan' # WonderSwan
    wonderswancolor: 'wonderswan-color' # WonderSwan Color
    x1: 'x1' # Sharp X1
    xbox: 'xbox' # Xbox
    xbox360: 'xbox360' # Xbox 360
    zmachine: 'z-machine' # Z-machine
    zx81: 'zx80' # ZX80
    zxspectrum: 'zxs' # ZX Spectrum
    naomi: 'arcade'
    naomi2: 'arcade'
    naomigd: 'arcade'

  # Asociate one platform to it's main version
  versions:
    naomi: 'arcade'

filesystem:
  # The folder name where your roms are located
  roms: 'roms' # For example if your folder structure is /home/user/library/roms_folder

Additional context
I realized after I forgot to remove the folders that are 1:1 with RomM, and ES-DE has quite a few folders that RomM doesn't have on it's support list (and vice-versa), but hopefully this helps someone. Also note that there are likely a few folders that aren't mapped simply because I didn't know they were for the same system.
@DarkSirrush DarkSirrush added the feature New feature or request label May 28, 2024
@gantoine
Copy link
Member

I love this idea, would this work?

# This config file is compatible with the ES-DE Emulation Frontend
# Rename this file to `config.yml`, copy it to a `config` folder, and mount that folder as per the docker-compose.example.yml
# Only uncomment the lines you want to use/modify, or add new ones where needed

exclude:
  roms:
    single_file:
      extensions:
        - 'xml'
        - 'txt'
      names:
        - 'roms'
        - 'pfx'
        - 'info.txt'
        - 'metadata.txt'
        - 'systeminfo.txt'

system:
  platforms:
    3do: '3do' # 3DO Interactive Multiplayer
    n3ds: '3ds' # Nintendo 3DS
    amstradcpc: 'acpc' # Amstrad CPC
    amiga: 'amiga' # Amiga
    amigacd32: 'amiga-cd32' # Amiga CD32
    android: 'android' # Android
    apple2gs: 'apple2gs' # Apple IIGD
    apple2: 'appleii' # Apple II
    arcade: 'arcade' # Arcade
    arcadia: 'arcadia-2001' # Arcadia 2001
    arduboy: 'arduboy' # Arduboy
    astrocde: 'astrocade' # Bally Astrocade
    apfm1000: 'apf' # APF-M1000/Imagination Machine
    atarijaguarcd: 'atari-jaguar-cd' # Atari Jaguar CD
    atarist: 'atari-st' # Atari ST/STE
    atari2600: 'atari2600' # Atari 2600
    atari5200: 'atari5200' # Atari 5200
    atari7800: 'atari7800' # Atari 7800
    atari800: 'atari8bit' # Atari 8-bit
    c16: 'c16' # Commodore 16
    c64: 'c64' # Commodore C64/128/MAX
    pv1000: 'casio-pv-1000' # Casio PV-1000
    colecovision: 'colecovision' # ColecoVision
    cdtv: 'commodore-cdtv' # CDTV
    crvision: 'creativision' # CreatiVision
    dreamcast: 'dc' # Dreamcast
    dos: 'dos' # DOS
    dragon32: 'dragon-32-slash-64' # Dragon 32/64
    channelf: 'fairchild-channel-f' # Channel F
    famicom: 'famicom' # Family Computer
    fds: 'fds' # Family Computer Disk System
    fmtowns: 'fm-towns' # FM Towns
    gameandwatch: 'g-and-w' # Game & Watch
    gamecom: 'game-dot-com' # Game.Com
    gb: 'gb' # Game Boy
    gba: 'gba' # Game Boy Advance
    gbc: 'gbc' # Game Boy Color
    megadrive: 'genesis-slash-megadrive' # Genesis/Mega Drive
    lcdgames: 'handheld-electronic-lcd' # Handheld Electronic LCD
    intellivision: 'intellivision' # Intellivision
    j2me: 'j2me' # J2ME
    atarijaguar: 'jaguar' # Atari Jaguar
    atarilynx: 'lynx' # Atari Lynx
    macintosh: 'mac' # Mac
    megaduck: 'mega-duck-slash-cougar-boy' # Mega Duck/Cougar Boy
    msx: 'msx' # MSX
    msx2: 'msx2' # MSX2
    n64: 'n64' # Nintendo 64
    nds: 'nds' # Nintendo DS
    neogeocd: 'neo-geo-cd' # Neo Geo CD
    ngp: 'neo-geo-pocket' # Neo Geo Pocket
    ngpc: 'neo-geo-pocket-color' # Neo Geo Pocket Color
    neogeo: 'neogeoaes' # Neo Geo
    nes: 'nes' # Nintendo Entertainment System
    gc: 'ngc' # GameCube
    n64dd: 'nintendo-64dd' # Nintendo 64DD
    odyssey2: 'odyssey-2-slash-videopac-g7000' # Odyssey 2/Videopac G7000
    oric: 'oric' # Oric
    palm: 'palm-os' # Palm OS
    pc88: 'pc-8800-series' # PC-8800 Series
    pc98: 'pc-9800-series' # PC-9800 Series
    pcfx: 'pc-fx' # PC-FX
    pokemini: 'pokemon-mini' # Pokémon mini
    psx: 'ps' # PlayStation
    ps2: 'ps2' # PlayStation 2
    ps3: 'ps3' # PlayStation 3
    ps4: 'ps4--1' # PlayStation 4
    psp: 'psp' # PlayStation Portable
    samcoupe: 'sam-coupe' # SAM Coupé
    satellaview: 'satellaview' # Satellaview
    sega32x: 'sega-32x' # SEGA 32X
    mastersystem: 'sega-master-system' # SEGA Master System
    sega32x: 'sega32' # Sega 32X
    megacd: 'segacd' # SEGA CD
    sfc: 'sfam' # Super Famicom
    sg-1000: 'sg1000' # SG-1000
    x68000: 'sharp-x68000' # Sharp X68000
    snes: 'snes' # Super Nintendo Entertainment System
    spectravideo: 'spectravideo' # Spectravideo
    supergrafx: 'supergrafx' # PC Engine SuperGrafx
    supervision: 'supervision' # Supervision
    switch: 'switch' # Nintendo Switch
    symbian: 'symbian' # Symbian
    ti99: 'ti-99' # Texas Instruments TI-99
    trs-80: 'trs-80' # TRS-80
    tg-cd: 'turbografx-16-slash-pc-engine-cd' # TurboGrafx CD
    tg16: 'turbografx16--1' # TurboGrafx-16
    vectrex: 'vectrex' # Vectrex
    vic20: 'vic-20' # Commodore VIC-20
    videopac: 'videopac-g7400' # Videopac+ G7400
    virtualboy: 'virtualboy' # Virtual Boy
    vsmile: 'vsmile' # V.Smile
    wii: 'wii' # Wii
    wiiu: 'wiiu' # Wii U
    pc: 'win' # PC (Microsoft Windows)
    wonderswan: 'wonderswan' # WonderSwan
    wonderswancolor: 'wonderswan-color' # WonderSwan Color
    x1: 'x1' # Sharp X1
    xbox: 'xbox' # Xbox
    xbox360: 'xbox360' # Xbox 360
    zmachine: 'z-machine' # Z-machine
    zx81: 'zx80' # ZX80
    zxspectrum: 'zxs' # ZX Spectrum
    naomi: 'arcade'
    naomi2: 'arcade'
    naomigd: 'arcade'

@DarkSirrush
Copy link
Author

It appears to work well, though I noticed I missed a couple default files to exclude - and it won't exclude subdirectories.

Additionally, it looks like the Model2 and Xbox 360 put roms in a subdirectory (called 'roms' annoyingly), which RomM doesn't seem to be able to handle (I did try setting the Xbox360 platform to xbox360/roms and it didn't help)

exclude:
  roms:
    single_file:
      extensions:
        - 'xml'
        - 'txt'
      names:
        - 'roms' #is a folder, this filter is ignored
        - 'pfx' #is a folder, this filter is ignored
        - 'info.txt'
        - 'metadata.txt'
        - 'systeminfo.txt'
        - 'psy.ggjud.iso'
        - 'psy.ggjud.nfo'
        - 'mlc01' #is a folder, this filter is ignored
        - '.Trash*' #is a folder, this filter is ignored

@gantoine
Copy link
Member

Ok awesome I've included this, it'll be in the code base after the next release (3.2.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gantoine @DarkSirrush