We will detail here the 7 panels that make up the ARRM interface

Please refer to the previous chapter which details all tabs of the ARRM configuration panel.

• Roms Folder : Enter here the path to the ROM directories (network or local).

It can be a network directory (if you are accessing your frontend by network):

• For Batocera: \\batocera\share\roms
• For Recalbox: \\recalbox\share\roms
• For Retropie: \\retropie\roms

or a local disk (if you access the memory card / disk of your frontend connected to your PC):

• E:\recalbox\share\roms (if you access the memory card / disk of your recalbox connected to your PC

• Directory of overlays (textbox): Specify here the path to the root directory that will contain the overlays. :
  • For Batocera: \\batocera\share
  • For Recalbox: \\recalbox\share
  • For Retropie: \\retropie

For Batocera, Recalbox and Retropie you can also specify another temporary directory that will receive the overlays generated, but in this case you will need to copy / paste this content on your Box.

• With Recalbox the generated directories will be ' overlays ' and ' system ' to be copied in '\\recalbox\share '
• With Batocera the generated directory will be ' decorations ' to copy in ' \\batocera\share '
• With Retropie the generated directory will be ' configs ' to copy in '/opt/retropie ' on your Retropie

Remember to click on the 'V' buttons to validate the directories. The icons open the directory in your file explorer.

• Display / Screenscraper : If you select only one system, the 'Display' button appears. If multiple systems are selected, the 'Screenscraper' button appears.
  • Display: By clicking this button, ARRM will load the file Gamelist.xml in the database or create it and check the consistency with the Roms in the directory. If Roms are not present in the Gamelist.xml they will be added to the Database. Conversely, if there are no Roms present in the gamelist.xml in the directory, they will not be taken into account in the Database. During this phase, ARRM verifies the existence of the image files present in the gamelist.xml and deletes the reference if the image file does not exist in the directory. Once these processes are completed, the database is displayed.
  • Screenscraper: By clicking this button, ARRM will sequentially process each of the systems automatically. It performs the processing of the 'Display' button above and then scrapes automatically on Screenscraper (only), saves the gamelist.xml, and then moves on to the next system.

• Recompose image (button): If multiple systems are selected, the 'Recompose image' button appears. It allows to apply the template to all the roms of the selected systems. The template will be the default if 'Template Auto Association' or 'Auto Template' are not checked; otherwise it will be the template associated with the processed system that will be applied.

• All : Select all systems.

• Reset Systems : De-selects all checked systems.

• Browse directory : Open the selected system folder.

• System overlay : Overlays recovery of selected systems, and creation of overlays configuration files. They will be stored in the directory mentioned in Directory of overlays . See the paragraph specifically devoted to the recovery of overlays games and systems. The icon opens the directory where overlays model files are stored.

• Use gamelist ARRM (checkbox): when a gamelist.xml is created by ARRM, ARRM creates a gamelist_ARRM.xml copy. When choosing a system, if the checkbox 'use ARRM gamelist' is checked, ARRM will use this gamelist_ARRM.xml file and not the gamelist.xml file which could have been modified by the frontend. This makes it possible not to lose the custom ARRM tags that may have been deleted by the Frontend. This is useful for someone who regularly comes back to, for example, his gamelist.xml to do 'image recomposing' or other manipulations offered by ARRM. Otherwise it shouldn’t interfere.

• Extensions : displays the list of extensions recognized for this system. Only the files containing these extensions will be displayed in the database. This list is powered by the file % appdata%\roaming\Nexouille soft\arrm\database\systems_extensions.txt which contains the extensions recognized by Recalbox, Batocera AND Retrope. If you want to remove/add extensions, please refer to the files '_lisezmoi.txt/_readme.txt' for Recalbox and '_infos.txt' for Batocera present in each system directory that contains the list of recognized extensions. You can edit this file via the configuration panel, 'General Options' tab, 'Edit Extensions' button. You have to restart ARRM to take effect.

• Global Filter (textbox): allows a filter to be applied during multi-system processing (scrape or recompose). Enter the filter in the textbox or select an already created filter. See Scraper your Roms with ARRM

• HTML Systems (button) : generates an HTML file, very basic, for the selected systems, allowing to view the content of each system (roms, images, manual, video, textual information ). On large systems, processing can take a long time. View example : https://youtu.be/piWMxeO6hKA

—-

This window that I call the Database contains the information that will be written in the gamelist.xml during its backup / creation. Some fields are editable, but it is better to go through the 'Information Rom' panel that applies input controls.

This database is filled when selecting a system. It will contain the info of the gamelist.xml (if it exists) and the files present in the current system directory (if they did not exist in the existing gamelist.xml)

By tapping on a letter on the Database (if sorted in alphabetical order), the index (highlight) will be positioned on the first found game name beginning with that letter.

Undock / Dock (button): allows you to detach the database from the main form and thus be able to move it and resize it.

View video

Example with the detached database:

Select all (button): Selects all the elements of the database.
Select none (button): Deselects all the elements of the database.
No filter (button): Removes all filters applied to the database.

On this Database we will be able to apply

• Filters
• Research
• Replacements
• Actions, triggered by various buttons of the panel 'Possible actions on selected Roms' (4)

Check the fields on which you want to perform a filter.

Check WITHOUT or WITH if you want to filter the selected fields having ( WITH ) a media or not having one ( WITHOUT )

These filters can be combined with each other by applying the AND / OR operator which will apply to all the conditions checked. The OR operator and most often used. Example:

• With AND : 'Without description' AND 'Without image'
• With OR : 'Without description' OR 'Without video'

• Query (textbox) : Permet de composer vos propres conditions (syntaxe MS ACCESS SQL ) de la forme :

boxart_rom<>'' and favoris_rom=true and rating_rom > 0.2
nomjeu_rom like '*zelda*' and map_rom is null
favoris_rom=true and (image_rom is null and manual_rom<>'')

The fields available for the conditions are:

  * nomjeu_rom
  * fichier_rom
  * description_rom
  * image_rom
  * rating_rom
  * annee_rom
  * developer_rom
  * publisher_rom
  * genre_rom
  * players_rom
  * cache_rom
  * favoris_rom
  * numauto_rom
  * boxart_rom
  * screenshot_rom
  * wheel_rom
  * video_rom
  * mix_rom
  * playcount_rom
  * lastplayed_rom
  * md5_rom
  * core_rom
  * emulator_rom
  * cartridge_rom
  * hash_rom
  * manual_rom
  * region_rom
  * thumbnail_rom
  * marquee_rom
  * genreid_rom
  * fanart_rom
  * map_rom
  * titleshot_rom
  * lang_rom
  * adult_rom
  * kid_rom
  * gameid_rom
  * arcadesystemname_rom
  * boxback_rom
  * gametime_rom
  * temporary_rom

Each condition validated via the Filter button is stored in the ' Query ' combobox and saved in the file located under %appdata%\Nexouille Soft\arrm\database\query_sql.txt (you can edit it and add the conditions you want) You will then be able to select a condition that is already archived.

You can read the condition that was executed by ARRM, in the statusbar

• Filter (button): Activates the filters defined above

• Missing Overlays (button) : (since version ARRM 1.8.7.5 beta 9 ) Select (highlight) roms that do not have Overlays.

• Favorites List (button): Filters the Database to display only the Roms with the Tag Favorites checked
• Hidden List (button): Filters the Database to show only Roms with hidden Tag checked
• Select all (button): Selects all the Roms in the Database
• Select none (button): Do not select any of the Rom from the Database
• No filter (button): Disables all filters applied to the Database
• Show hidden (button): If checked, also show Roms with hidden tag checked. Filter is persistent.

• DB fields (combobox): Select a database field (gamelist). This will fill the second combobox with all the values of this field found in the database (gamelist). Click on the green checkmark to filter on this value. You can manually modify the content of this second combobox

• Search string in Title, Desc or name Rom (Listbox): Allows to filter the Database on a chain of character. The search is carried out on the fields Title, Desc or Name file Rom
• Filter duplicated Roms on (button): Allows to search for duplicated Roms according to 3 modes. The searches are done on the names of roms or files expurgated of () and []:
  • Name : Searches for Roms containing in the game name a part of a name of another rom. Example: The following game names appear as duplicate game : 'Asterix', 'Asterix And The Great Rescue' and 'Asterix And The Secret Mission'. Charge to you to make your selection.
  • Exact Name : Searches for Roms containing in the game name the exact name of another rom. Useful if you have clones (different rom file) but whose game name is the same. Apply once the game was scraped because the game names returned will be accurate. Example: the roms 'Speedball (Europe) (Mirrorsoft).zip' and 'Speedball (Europe) (Virgin).zip' will return the same game name (Speedball)
  • File : Searches for the Roms containing in the file name part of the file name of another Rom. Example: 'Back to the Future Part II (Europe).zip' and 'Back to the Future Part III' (Europe).zip

View video

  %%nomjeu_rom%%
  %%fichier_rom%%
  %%description_rom%%
  %%image_rom%%
  %%rating_rom%%
  %%annee_rom%%
  %%developer_rom%%
  %%publisher_rom%%
  %%genre_rom%%
  %%players_rom%%
  %%cache_rom%%
  %%favoris_rom%%
  %%boxart_rom%%
  %%playcount_rom%%
  %%lastplayed_rom%%
  %%region_rom%%
  %%genreid_rom%%
  %%lang_rom%%
  %%adult_rom%%
  %%kid_rom%%
  %%gameid_rom%%
  %%arcadesystemname_rom%%
  %%gametime_rom%%
  %%temporary_rom%%

• Query (combobox): Allows you to compose your own conditions/filters (MS ACCESS SQL syntax). (It is OPTIONAL )

fichier_rom like '%(USA)%'
nomjeu_rom not like '%[%' and region_rom is not null
boxart_rom<>'' and favoris_rom=true and rating_rom > 0.2
nomjeu_rom like '*zelda*' and map_rom is null
favoris_rom=true and (image_rom is null and manual_rom<>'')

The fields available for the conditions are:

  * nomjeu_rom
  * fichier_rom
  * description_rom
  * image_rom
  * rating_rom
  * annee_rom
  * developer_rom
  * publisher_rom
  * genre_rom
  * players_rom
  * cache_rom
  * favoris_rom
  * numauto_rom
  * boxart_rom
  * screenshot_rom
  * wheel_rom
  * video_rom
  * mix_rom
  * playcount_rom
  * lastplayed_rom
  * md5_rom
  * core_rom
  * emulator_rom
  * cartridge_rom
  * hash_rom
  * manual_rom
  * region_rom
  * thumbnail_rom
  * marquee_rom
  * genreid_rom
  * fanart_rom
  * map_rom
  * titleshot_rom
  * lang_rom
  * adult_rom
  * kid_rom
  * gameid_rom
  * arcadesystemname_rom
  * boxback_rom
  * gametime_rom
  * temporary_rom

Each condition/filter validated via the button is stored in the ' Query ' combobox and saved in the file located under %appdata%\Nexouille Soft\arrm\database\query_sql2.txt (you can edit it and add any conditions you want) You will then be able to select an already archived condition/filter.

The filter is applied to the Database

EXAMPLES :

Apply a modification of the value of a field

In the example above, we apply the Query:

nomjeu_rom not like '%[%' and region_rom is not null

which means that we want to display only the games which do not contain '[' and whose region field is not empty.

In the next combobox we indicate the new value. It can also be a field name from the database, it must then be surrounded by double % exemple :

%%nomjeu_rom%% [%%region_rom%%]

Select the field on which you want to apply modifications, here it will be the field Game Title (nomjeu_rom)

Select (highlight) the games you want to apply the changes to, then click the button to apply the change.

This will change the DB Fields Game Title (nomjeu_rom) so that it becomes nomjeu_rom [region_rom]

On the game ' Ballbllazer ' whose field region_rom = 'us' this will give: Ballblazer [us]

EXAMPLES :

Apply a value replacement on a field

In the example above, we apply the Query (It is OPTIONAL ):

fichier_rom like '%(USA)%'

which means that we want to display only the games whose fichier_rom (file name) contains '(USA)'.

Select the field on which you want to apply modifications, here it will be the field Genre (genre_rom)

Select (highlight) the games you want to apply the changes to, then click the button to apply the change.

This will replace in the DB Fields Genre (genre_rom) the string 'Tir' by 'Shoot'

%%nomjeu_rom%%

Filter 'Arcade Clone' (button) : Allow you to find and filter Clones of Roms for Arcade systems. The line (Clone of: rom_name → rom_title) is added in the 'temporary_rom' field. The filter (temporary_rom like '*Clone Of:*') is added to the filters of the Query combobox.

' Highlight the Roms whose core … ' (Combobox): Select the desired Core (combobox), then click on the green checkmark to highlight the Roms whose selected core is the best. See tutorial : Find the best emulator / core for Arcade games

All the actions associated with the buttons in this menu apply to the selected Roms (highlighted) in the Database

• Tag as Favorites (button): Places in Favorites the selected Roms
• Tag as Hidden (button): Hidden the selected Roms
• Tag as Normal (button): Normalizes the selected Roms (removes the Favorites and Hidden tags)
• Create M3U (button) : See Create .M3U files for multi-disc Roms
• Check name with MD5 (button): Check the correct name of the game on Screenscraper with its MD5
• Check Roms (button): Applies checkboxes 'Clean name', 'Add disk', 'Keep Rom name' and 'Add Country' for selected Roms
• Rom as game name (button): Renames the selected files with the name of the game. The checkboxes 'Clean name', 'Add disk', 'Keep Rom name' and 'Add Country' are also applied. Be careful when renaming .bin/.cue .iso/.cue .bin/.lst files, the contents of the text files (.cue /.lst) are not modified. Remember to modify it to agree with the new filename .bin/.iso.
• Update Core (button): For Arcade systems (FBA, MAME, Neogeo), assigns the best-suited emulator and core from the BestArcade4Recalbox file.
• Remove picture (button): Physically erases image files of selected Roms.
• Media exists ? (button): When loading the gamelist, checks if the referenced media exist locally, otherwise the media reference is deleted from the database. If the 'Find missing images' checkbox is checked in the 'General options' tab, ARRM tries to find the media locally (since 1882 beta 18)
• Move to folder (button): Moves the selected Roms to another folder. If the destination folder is outside the parent folder, the ROM will be moved and removed from the current gamelist. If the destination folder is a root folder of a system, the gamelist of the destination folder will be updated.
• Recompose image (button): Applies the selected default template or the associated template (if 'Auto template' is checked) on the selected Roms using the images already retrieved using the screenshot, boxart, marquee, cartridge tags of the database. If a tag is missing and the 'ignore local search' option is not enabled, ARRM checks for missing images in the images directory.
• CRC32 (button): Calculates and stores the CRC32 in the <hash> tag for the selected Roms. Used for Netplay under Recalbox
• MD5 (button): Calculates the MD5 and stores in the <md5> tag for the selected Roms. The MD5 is calculated on the Roms file and not on the Rom contained in the .Zip or .7z file.
• . Zip (checkbox): By checking this box the calculation of the MD5 or CRC32 is done in priority on the file contained in the file .Zip / .7z
• Reset Core/Emu (button): Allows you to apply an emulator and a core from a list for the selected Roms.
• Delete METADATA (button): Removes the METADATA (gamelist info) and retains only the ROM filename and the game name extracted from the Rom file name.

• Video + Overlay (button): Addition of a 'Video + Overlay' button allowing to create Video + Overlay (like the birthday videos of Screenscraper) based on the ARRM templates. They have the suffix -mixvideo.

A 'template_association_video.txt' file is used to associate templates with systems when creating 'video+overlay'.
By default the new template 'mix_video1' is associated with all systems.
A 'template_association_video.NEXT_PIXEL' file is included containing the associations for the templates of the NEXT_PIXEL theme. Rename it to 'template_association_video.txt' if you want to use it.
A folder reserved for video templates has been created, it is located in the directory: '%appdata%\Nexouille soft\arrm\ressources\templates_video\'
You can retrieve the usual templates located in '%appdata%\Nexouille soft\arrm\ressources\templates\', copy them to this directory ( '%appdata%\Nexouille soft\arrm\ressources\templates_video\' ) and modify them to adapt them to your needs.
When using the 'Video+Overlay' button ARRM checks for the existence of the template_association_video.txt file and applies the video template associated with the current system (auto_template enabled). If the template_association_video.txt file does not exist, ARRM will apply the usual templates (template_association.txt)

• Recover music : If no music file exists, allows you to extract from the video file the audi track in .mp3 which will be stored in the music folder defined in the 'Folder' tab. If 'GamesDB Music' is checked and no music file exists, ARRM attempts to retrieve the music from the GamesDatabase site. A <music> tag will be created in the gamelist (usable with my JVB_Quizz game : http://jujuvincebros.fr/telechargements2/category/13-games)

• Resize Overlays : You already have overlays, but you want to resize them to fit your new screen resolution. You have two choices: retrieve the overlays again by indicating the desired resolution, or resize the overlays you already have (faster with this button). The resizing consists in calculating the new values ​​(coordinates) which will be placed in the configuration files. Using this button, the .png image files will not be modified. Seek wiki : Resize existing overlays

• mamedb.org (button): Searches the selected Roms info on the MameDB.org site. This site only gives information about the games themselves. The info is quite succinct and it only returns a screenshot.
• TheGamesDB.net (button): Searches the selected Roms info on the TheGamesDb site. Prioritize the Screenscraper platform which is much more available and complete.
• Screenscraper (button): Searches the info of the selected Roms on the Screenscraper website. Prioritize this scraper which is complete and fast.
• (button): For each scraper (TheGamesDb.net and Screenscraper), allows to associate the system name on your Recalbox/Batocera with its identification on the Scrape website. the files are located in %appdata%\roaming\Nexouille Soft\arrm\database\systemes_screenscraper.txt and systemes_tgbd.txt. You can add other systems.

Example of the contents of the file ' systemes_screenscraper.txt ':

megadrive|1
genesis|1
mastersystem|2
nes|3
family_computer|3
snes|4
sfc|4
cps1|6
cps2|7
...
gba|12
gamecube|13
gc|13
n64|14
...

• Choose Mix Template (button): Allows you to choose from a list, the Template to apply when 'Mix' was chosen in 'Image Options'
• Auto template (checkbox): When scraping, allows to associate a template to a system thanks to the file %appdata%\roaming\Nexouille soft\arrm\database\template_association.txt, which you can edit by clicking the button.

This screen allows you to choose the templates to use. Here you can configure three types of templates: Default (non auto template) , Default (auto template) , System (auto template)

On the left of the screen:

The Default (non auto template) panel indicates the default template that will be used for all scraped systems when the ' Auto template ' checkbox is not checked. To select it, you just have to choose a template from the list and check the button ' Define as default template ' located under the selected template.

On the right of the screen, in the section ' Auto Template Settings ':

The Default (auto template) panel indicates the default template that will be used for all scraped systems when the ' Auto template ' checkbox is checked. To select it, you just have to choose a template from the list and check the button ' Set as default template '.

The System (auto template) panel indicates the template that will be used for the selected system when the ' Auto template ' checkbox is checked. To select it, you just have to choose a template from the list and check the button ' Define as template for' system name ''.

These actions update the file %appdata%\roaming\Nexouille soft\arrm\database\template_association.txt

The button ' Edit XML file ' allows you to open the XML file of the selected template in your text file editor and modify it. See the section Create your own template for ARRM

The button ' See Directory ' opens the directory containing the .XML file and the associated image files.

The ' Exit ' button closes this screen and returns to the main screen.

Please read the section devoted to this subject : Editing game data

The file 'scrape_log.txt' is positioned in the '%appdata%\Nexouille Soft\arrm\temp\logs_arrm' directory of the selected system.

You can select the interface language by checking the appropriate flag

• Check ARRM Updates (button): Allows you to know if a new version or a Beta is available

• Check ScreenScraper (button): Indicates the status of the server, as well as your quotas and limitations.