From 08d6948ad1f51fe667c4b2744024b29d1a8fd835 Mon Sep 17 00:00:00 2001 From: zurdi Date: Tue, 9 Jul 2024 10:25:48 +0200 Subject: [PATCH 1/3] fixed config.example.yml --- examples/config.example.yml | 51 +++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 28 deletions(-) diff --git a/examples/config.example.yml b/examples/config.example.yml index 5118fced2..25abd4785 100644 --- a/examples/config.example.yml +++ b/examples/config.example.yml @@ -4,8 +4,7 @@ exclude: # Exclude platforms to be scanned - platforms: - # - 'romm' + platforms: [] # ['my_excluded_platform_1', 'my_excluded_platform_2'] # Exclude roms or parts of roms to be scanned roms: @@ -13,44 +12,40 @@ exclude: # 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' - # Exclude matched file names to be scanned - names: - # - 'info.txt' - # - '._*' # Supports unix filename pattern matching - # - '*.nfo' # Can also exclude files by extension + extensions: [] # ['xml', 'txt'] + + # Exclude matched file names to be scanned. + # Supports unix filename pattern matching + # Can also exclude files by extension + names: [] # ['info.txt', '._*', '*.nfo'] # 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' + 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 + names: [] # ['data.xml', '._*'] # Supports unix filename pattern matching + # Exclude all files with certain extensions to be scanned from multi file roms - extensions: - # - 'txt' + extensions: [] # ['xml', 'txt'] -system: - # Asociate different platform names to your current file system platform names - # [your custom platform folder name]: [RomM platform name] - platforms: - # gc: 'ngc' # In this example if you have a 'gc' folder, RomM will treat it like the 'ngc' folder - # psx: 'ps' # In this example if you have a 'psx' folder, RomM will treat it like the 'ps' folder +# system: +# Asociate different platform names to your current file system platform names +# [your custom platform folder name]: [RomM platform name] +# platforms: +# gc: 'ngc' # In this example if you have a 'gc' folder, RomM will treat it like the 'ngc' folder +# psx: 'ps' # In this example if you have a 'psx' folder, RomM will treat it like the 'ps' folder - # Asociate one platform to it's main version - versions: - # naomi: 'arcade' +# Asociate one platform to it's main version +# versions: +# naomi: 'arcade' # The folder name where your roms are located -filesystem: - # roms_folder: 'roms' # For example if your folder structure is /home/user/library/roms_folder +# filesystem: +# roms_folder: 'roms' # For example if your folder structure is /home/user/library/roms_folder From 93c36a4fcebc5aa0e55c55526697a9dbbf510a4b Mon Sep 17 00:00:00 2001 From: zurdi Date: Tue, 9 Jul 2024 10:28:10 +0200 Subject: [PATCH 2/3] removed upgrade to 3.0 warning --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 22ec99d31..8ad173fcd 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,6 @@ -> [!WARNING] -> Version 3.0 introduces exciting new features that require changes to how RomM is set up and configured. **If you're currently running a 2.x version, please review the [migration guide](https://github.com/rommapp/romm/wiki/Upgrading-to-3.0) before upgrading.** - # Table of Contents - [Overview](#overview) From 4bd6a121d66a4729d540704abc472c2b96172c16 Mon Sep 17 00:00:00 2001 From: zurdi Date: Tue, 9 Jul 2024 10:35:07 +0200 Subject: [PATCH 3/3] placeholder for config dictionaries --- examples/config.example.yml | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/examples/config.example.yml b/examples/config.example.yml index 25abd4785..d4f7656b2 100644 --- a/examples/config.example.yml +++ b/examples/config.example.yml @@ -35,17 +35,14 @@ exclude: # Exclude all files with certain extensions to be scanned from multi file roms extensions: [] # ['xml', 'txt'] -# system: -# Asociate different platform names to your current file system platform names -# [your custom platform folder name]: [RomM platform name] -# platforms: -# gc: 'ngc' # In this example if you have a 'gc' folder, RomM will treat it like the 'ngc' folder -# psx: 'ps' # In this example if you have a 'psx' folder, RomM will treat it like the 'ps' folder +system: + # Asociate different platform names to your current file system platform names + # [your custom platform folder name]: [RomM platform name] + # In this example if you have a 'gc' folder, RomM will treat it like the 'ngc' folder and if you have a 'psx' folder, RomM will treat it like the 'ps' folder + platforms: {} # { gc: 'ngc', psx: 'ps' } -# Asociate one platform to it's main version -# versions: -# naomi: 'arcade' + # Asociate one platform to it's main version + versions: {} # { naomi: 'arcade' } # The folder name where your roms are located -# filesystem: -# roms_folder: 'roms' # For example if your folder structure is /home/user/library/roms_folder +filesystem: {} # { roms_folder: 'roms' } For example if your folder structure is /home/user/library/roms_folder