settings-en
Différences
Ci-dessous, les différences entre deux révisions de la page.
settings-en [2019/11/07 22:59] – [Tools] nexusone13 | settings-en [2023/06/03 17:38] (Version actuelle) – modification externe 127.0.0.1 | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
+ | #REDIRECT arrm_relooked_en: | ||
+ | |||
~~NOCACHE~~ | ~~NOCACHE~~ | ||
====== ARRM software setting ====== | ====== ARRM software setting ====== | ||
+ | |||
+ | __**Video Tutorial**__ | ||
+ | |||
+ | {{ youtube> | ||
+ | |||
+ | \\ | ||
+ | |||
+ | [[https:// | ||
When you run ARRM, you get this main screen (interface) | When you run ARRM, you get this main screen (interface) | ||
Ligne 6: | Ligne 16: | ||
{{ARRM: | {{ARRM: | ||
- | Before embarking on the manipulation of gamelists, roms and other scraps, it is necessary to configure the application so that it can meet your configuration and your needs. | + | Before embarking on the manipulation of gamelists, roms and other scrapes, it is necessary to configure the application so that it can meet your configuration and your needs. |
In the screenshot above, the setup part is surrounded by red to highlight it for this wiki. We will dwell on the 6 tabs that make up the setup part. | In the screenshot above, the setup part is surrounded by red to highlight it for this wiki. We will dwell on the 6 tabs that make up the setup part. | ||
---- | ---- | ||
+ | |||
+ | |||
+ | ===== Systems and overlays folders ===== | ||
+ | |||
+ | |||
+ | {{arrm: | ||
+ | |||
+ | * **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: | ||
+ | |||
+ | |||
+ | |||
+ | <note warning> | ||
+ | for ARRM to work with ** Retropie **, the following paths must be respected on Retropie: | ||
+ | |||
+ | * ** Roms ** must be in ** ~/ | ||
+ | * The ** gamelist.xml ** must be in ** ~/ | ||
+ | </ | ||
+ | |||
+ | * ** 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 | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | 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 ' | ||
+ | * With Batocera the generated directory will be '** decorations **' to copy in '** \\batocera\share **' | ||
+ | * With Retropie the generated directory will be '** configs **' to copy in ' | ||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | * **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%\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 ' | ||
+ | | ||
+ | * **Click to edit** (label): allows to indicate the systems which must be treated in **Folder Mode** | ||
+ | |||
+ | |||
+ | ---- | ||
+ | | ||
Ligne 20: | Ligne 81: | ||
* ** Disable music ** (checkbox): removes intro and outro music from the application | * ** Disable music ** (checkbox): removes intro and outro music from the application | ||
- | * ** End scrap alert ** (checkbox): allows to play a sound at the end of scrap | + | * ** End scrape |
- | + | ||
- | * ** Image directory name ** (textbox): name of the directory containing the images retrieved by the scraper. | + | |
- | * For Recalbox & Batocera: downloaded_images | + | |
- | * For Retropie: images or media | + | |
- | * You can set as directory name a path like this : ' | + | |
- | * ** Videos Directory name ** (textbox): name of the directory containing | + | * ** Preview Medias |
- | | + | {{: |
- | | + | < |
+ | |||
+ | | ||
+ | < | ||
+ | If your gamelist is already finalized, you can disable this option to speed up the loading of the gamelist in ARRM | ||
+ | </ | ||
+ | | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | < | ||
+ | If your gamelist is already finalized, you can disable this option to speed up the loading of the gamelist in ARRM | ||
+ | </ | ||
+ | * ** 4 images mode activation** (checkbox): By checking this box you get the 4 images (screenshot, | ||
+ | |||
+ | < | ||
+ | To benefit from all the features of ARRM, it is advisable to activate 4 images mode. | ||
+ | </ | ||
+ | |||
+ | * **Activate Cache** (checkbox) : makes it possible to keep in a cache the textual information recovered during a Scrape. Can be used for example following a crash during a scrape or a missing gamelist. | ||
* ** Edit No MD5 ** (button): open the file **// | * ** Edit No MD5 ** (button): open the file **// | ||
Ligne 37: | Ligne 112: | ||
* ** Edit extensions ** (button): Changes the file extensions allowed by system. You must restart the program if changes have been made to this file. This file // | * ** Edit extensions ** (button): Changes the file extensions allowed by system. You must restart the program if changes have been made to this file. This file // | ||
- | * ** Edit Arcade core ** (button): open the file /// | + | * ** Edit Arcade core ** (button): open the file /// |
- | * ** Template association ** (button): opens the file // **%appdata%\Nexouille soft\arrm\database\template_association.txt ** // which indicates which template mix associated with each system. | + | * ** Template association ** (button): opens the file // **%appdata%\Nexouille soft\arrm\database\template_association.txt ** // which indicates which template mix associated with each system. Template association is done when the checkbox ' |
* **Overlays Path** (bouton) : Opens file : // | * **Overlays Path** (bouton) : Opens file : // | ||
- | |||
- | * ** Extra Tag + Default Image ** (button): Accesses the configuration menu for recovery of boxart, screenshot, marquee, video, cartridge, mix and setting custom tag setup. By activating the recovery of the boxart, screenshot, marquee and cartridge, you can use the button ' | ||
- | {{ARRM:functionality: | + | * **Assignment of media Screenscraper + Media order** (button) (from 1.8.1.6): Goes to the page that allows you to assign the Screenscraper media to the different |
+ | |||
+ | * **Assignment of media Launchbox** (button) (from 1.9.0.2 Beta 11): Goes to the page that allows you to assign the Launchbox media to the different ARRM TAGs. [[media-assignation-launchbox-en|see the dedicated section]]. | ||
+ | * **Profile (Save/Load) ** (button) <color # | ||
- | * ** Activation of recovery of 4 images + TAG Custom ** (checkbox): By checking this box you get the 4 images (screenshot, | + | ---- |
- | * ** Download video (video TAG) ** (checkbox): By checking this box you download the video of the ROM in the image directory. This video will appear in the gamelist.xml with the tag < | + | ===== Folders ===== |
- | * ** Tags Custom section**: The tags used by default in ARRM (boxart, screenshot, mark, mix, cartridge, video) correspond to those used in Recalbox, Batocera, and Retropie. For one reason or another (new frontend, or personal need), it's possible to change the names of the tags that will appear in your gamelist.xml | + | {{arrm:options: |
- | | + | in which you can configure the paths for each of the media (image, screenshot, boxart, wheel, cartridge, titleshot, map, fanart, manual, video) |
+ | |||
+ | It could be like this : | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | * media/ | ||
+ | * media/ | ||
+ | * etc... | ||
+ | |||
+ | Since version **<color # | ||
+ | Example | ||
+ | | ||
+ | * Looney Tunes - Duck Dodgers (E) [!]**-image**.png | ||
+ | |||
+ | |||
+ | By default | ||
+ | *-image | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | |||
+ | It is possible not to add a suffix by leaving the textbox empty. | ||
+ | |||
+ | <note warning> | ||
+ | |||
+ | |||
+ | When scraping media, these suffixes will be applied to the recovered media. | ||
+ | |||
+ | <note important> | ||
---- | ---- | ||
- | ===== Scrap Options ===== | + | ===== Scrape |
{{ARRM: | {{ARRM: | ||
- | * ** Clean rom ** (checkbox): | + | * ** Clean up rom ** (checkbox): |
* The Legend of Zelda: Ocarina of Time Legend of Zelda, The: Ocarina of Time | * The Legend of Zelda: Ocarina of Time Legend of Zelda, The: Ocarina of Time | ||
* The Bard's Tale -> Bard's Tale, The | * The Bard's Tale -> Bard's Tale, The | ||
- | * ** Add disk ** (checkbox): When scrape or check of the name with MD5, ARRM adds the diskette number, Side number, and AGA/CD32 (for Amiga) at the end of the name (if this information is present in the file name) Examples: | + | * ** Add disk ** (checkbox): When scrape or check of the name with MD5, ARRM adds the diskette number, Side number, and AGA/CD32 (for Amiga) at the end of the name (if this information is present in the file name). The elements sought by ARRM in the filename are: disc/ |
+ | |||
+ | \\ | ||
+ | < | ||
+ | The **add disk** checkbox now relies on the** multi_part_add_disk.txt** file to find and retrieve multi-disk information in the names of files \\ \\ | ||
+ | This file is located in \\ \\ | ||
+ | **%appdata%\Nexouille Soft\arrm\database\multi_part_add_disk.txt** \\ | ||
+ | \\ | ||
+ | Content of file looks like this : \\ \\ | ||
+ | |||
+ | < | ||
+ | disc|disk|file|part|side|tape | ||
+ | </ | ||
+ | \\ | ||
+ | </ | ||
+ | |||
+ | * Examples: | ||
* Indiana Jones and the Last Crusade (1989) (en) (Disk 1 of 3) .st -> Indiana Jones And The Last Crusade - The Graphic Adventure (Disk 1 of 3) | * Indiana Jones and the Last Crusade (1989) (en) (Disk 1 of 3) .st -> Indiana Jones And The Last Crusade - The Graphic Adventure (Disk 1 of 3) | ||
* Knockout (Alligata Software) (Side A) (Europe) .tzx -> Knockout (Side A) | * Knockout (Alligata Software) (Side A) (Europe) .tzx -> Knockout (Side A) | ||
Ligne 73: | Ligne 208: | ||
* ** Keep rom name ** (checkbox): When scrape or adding the disk number uses the name of the Rom file as the name of the game. This disables the 'Add disk' option because the Disk/ | * ** Keep rom name ** (checkbox): When scrape or adding the disk number uses the name of the Rom file as the name of the game. This disables the 'Add disk' option because the Disk/ | ||
- | * ** Auto search TGDB ** (checkbox): | + | * ** Add language |
* ** Add Country ** (checkbox): Add at the end of the name of the game the country if it is present in the file, or retrieved on Screenscraper if the MD5 of the game was filled. | * ** Add Country ** (checkbox): Add at the end of the name of the game the country if it is present in the file, or retrieved on Screenscraper if the MD5 of the game was filled. | ||
+ | |||
+ | * ** Strict search ** (checkbox): Allows to retrieve only the games whose PlateformId corresponds to the sought platform. | ||
* ** Image as Rom file ** (checkbox): During a scrape, the image file is named with the name of the Rom and not with the name of the game returned by the scraper | * ** Image as Rom file ** (checkbox): During a scrape, the image file is named with the name of the Rom and not with the name of the game returned by the scraper | ||
Ligne 82: | Ligne 219: | ||
* ** MD5 ** (checkbox): Arrm attempts a search on Screenscraper with the MD5 of the Rom when searching by filename does not work. Be careful calculating the MD5 can be a bit long with large files. To save time, you can prevent the calculation of the MD5 on some extensions by editing the list of extensions to avoid with the button 'Edit No MD5'on 'Main Options' | * ** MD5 ** (checkbox): Arrm attempts a search on Screenscraper with the MD5 of the Rom when searching by filename does not work. Be careful calculating the MD5 can be a bit long with large files. To save time, you can prevent the calculation of the MD5 on some extensions by editing the list of extensions to avoid with the button 'Edit No MD5'on 'Main Options' | ||
+ | |||
+ | * ** In .ZIP/.7z ** (checkbox): Sometimes searching with the MD5 on the zip gives nothing. By activating this option, ARRM will decompress the .ZIP/.7z and calculate the MD5 of the file contained in the .ZIP/.7z | ||
* ** No text ** (checkbox): During a scrape, does not take into account the textual information from the scraper. Useful if you have modified this information and do not want to be overwritten. | * ** No text ** (checkbox): During a scrape, does not take into account the textual information from the scraper. Useful if you have modified this information and do not want to be overwritten. | ||
+ | |||
+ | * **Force MD5 before scraping** (checkbox) : allows to calculate the MD5 (if not already present), before the scrape. The research of information will be done in priority via the MD5 of the Rom. | ||
+ | |||
+ | * ** Pad to Keyboard cfg ** (checkbox): When scraping, if this option is activated, ARRM retrieves the configuration file .p2k.cfg (or .keys for Batocera) from the current Rom. The file is stored in the directory where the rom is located and is called '** rom_filename.extension.p2k.cfg **'. This file is used to assign keyboard keys to the joypad. Useful for computer emulators that sometimes use keyboard keys in games. See explanations: | ||
+ | |||
+ | < | ||
+ | If you want to convert Recalbox .p2k files into Batocera compatible .keys files I invite you to use the [[https:// | ||
+ | </ | ||
+ | |||
+ | * ** World Flag ** (checkbox): Forces the addition of the World flag when no region is found. | ||
+ | | ||
+ | * **Compress video** (checkbox) : If checked, compresse video with handbrake. Compressing the videos also makes them compatible with the OMX player on Retropie. See : [[compress_video_en|Compress videos to save storage space]] | ||
+ | |||
+ | * ** Video+Overlay -> Video TAG** (checkbox): When using the ' | ||
+ | |||
+ | * ** PC / DOS: files mode **: The systems to be managed as directories (PC, DOS, Windows, PS3...) are indicated in the file **systemes_as_folder.txt** located in **%appdata%\Nexouille Soft\Arrm\database\**. This checkbox allows you to override and force file mode on these systems. | ||
+ | |||
+ | * ** GamesDB Music **: Finds music on the GamesDatabase site, stores it in the | ||
+ | |||
+ | * ** SpeedUp ** (checkbox): Accelerates image processing by removing the validity check from the recovered image file (file in the correct png format etc). When loading the ' | ||
+ | |||
+ | * ** Topstaff -> Favorites **: Put in favorite the games selected by the Screenscraper team | ||
+ | |||
+ | * ** Use GameID **: Uses in priority the GameID (if present in the database) to find the games in Screenscraper. | ||
+ | |||
+ | * ** ONLY use ARRM detection of ' | ||
+ | | ||
+ | * ** Auto Hide cue / gdi / m3u ** (checkbox) : <color # | ||
+ | | ||
+ | * **Without Artwork only** | ||
+ | | ||
+ | * **Ignore existing MD5** (checkbox): When scraping on Screenscraper, | ||
| | ||
- | * ** Ignore Local Search ** (checkbox): When performing | + | |
+ | Examples: | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | The recognized countries are: | ||
+ | |||
+ | AUSTRALIA, | ||
+ | BRAZIL,B,BR \\ | ||
+ | CHINA, | ||
+ | ENGLAND, | ||
+ | EUROPE, | ||
+ | FINLAND, | ||
+ | FRANCE, | ||
+ | GERMANY, | ||
+ | GREECE,GR \\ | ||
+ | ITALY, | ||
+ | JAPAN, | ||
+ | KOREA,SOUTH KOREA,K,KR \\ | ||
+ | NETHERLANDS, | ||
+ | SPAIN, | ||
+ | SWEDEN, | ||
+ | USA,4,U,US \\ | ||
+ | WORLD,WOR \\ | ||
+ | |||
+ | |||
+ | * **Translate description** (checkbox): **<color # | ||
+ | |||
+ | | ||
Ligne 99: | Ligne 299: | ||
| | ||
+ | |||
+ | |||
+ | * **Media order (combobox)** : allows you to select the country preset, which contains the order of the countries in which the media (images and texts) must be searched. See the dedicated section. Click on the button (with the arrows) to update the combobox (if the presets have been modified / added) | ||
---- | ---- | ||
Ligne 107: | Ligne 310: | ||
{{ARRM: | {{ARRM: | ||
- | You can select here the type of image that will be used in your frontend (Recalbox, Batocera, Retropie etc.) to represent | + | <note important> |
- | * Screenshot | + | |
- | * Boxart | + | |
- | * Marquee | + | |
- | * Mix | + | |
- | * Video | + | |
- | If the option '4 images' | + | * **Without Artwork only** |
- | By default ARRM retrieves | + | * ** 4 images mode activation** (checkbox): |
- | * ** Box ** (checkbox): If checked, ARRM tries to recover on the selected scrape site the 2D Boxart | + | < |
+ | To benefit from all the features | ||
+ | </ | ||
- | * ** Box 3D ** (checkbox): If this option is checked, ARRM retrieves the 3D box of the game (only on Screenscraper) if not then 2D | + | * **No image, only texts** (checkbox): If checked, |
- | * ** Screenshot ** (checkbox): If checked, ARRM attempts to retrieve the game's Screenshot from the selected scrape site | ||
- | * **Mix RB V1** (checkbox) : Allows to recover as screenshot the Mix V1 proposed by Screenscraper. Available only if V2 API is enabled. \\ {{arrm: | ||
- | * **Mix RB V2** (checkbox) : Allows to recover as screenshot the Mix V2 proposed by Screenscraper. Available only if V2 API is enabled. \\ {{arrm: | ||
- | * ** Screen Title ** (checkbox): Allows to recover as screenshot the Screen Title proposed by Screenscraper. You can check ' | ||
- | | + | You can select in the **combobox (Choose the image TAG you want)** the image that will be assigned to the **image TAG** and which will be the one used in your frontend |
- | * ** Mix ** (checkbox): If checked, ARRM creates a Mix with the images recovered on the scrape site by applying one of the templates proposed by ARRM. | + | The combobox allows you to choose between these different media: |
- | * ** Video ** (checkbox): If checked, ARRM retrieves only the video of the game (only on Screenscraper) that it places in the videos directory of the scraped system. If you wish to download the video as well as the other scrap informations, | + | * NONE (if you don't want to assign or modify |
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | * TITLESHOT | ||
+ | * WHEELS | ||
- | * ** Download video (video TAG) ** (checkbox): If checked, during | + | < |
+ | Be careful when you select one of the elements | ||
- | | + | < |
- | | + | For **Screenscraper** and **Launchbox**, you can associate these Media with those used on Screenscraper and Launchbox. See [[media-assignation-en|Screenscraper media assigment with ARRM]] and [[media-assignation-launchbox-en|Launchbox assigment |
- | * ** {{:arrm:eye-icon-1481.png? | + | |
- | * **Dev** (checkbox) : Retrieves an overlay image with the viewport area detected by Arrm surrounded by yellow. This allows overlay errors to be detected and corrected. | + | |
- | * **4/3** : Only retrieves overlays in 4/3 format | + | |
- | * **16/9** : Only retrieves overlays in 16/9 format | + | |
- | * **-> 720** : Convert 1080 overlays to 720 and change viewport coordinates accordingly. This option also applies to recovering system overlays. | + | |
+ | <note warning> | ||
+ | If the option '4 images' | ||
- | * ** Manual ** (checkbox): If checked, | + | By default |
- | * ** Cartridge ** (checkbox): If checked, ARRM attempts to retrieve the cartridge of the game. | ||
- | * ** Delete unused images files ** (button): Erases all images in the current system folder that are not associated with a Rom file in the gamelist.xml | + | * **BOX 3D**: allows you to recover |
- | * ** Show Mix model ** (button): Displays | + | * **Custom Marquee**: allows you to create a mini marquee with integrated wheel/logo based on the marque_fanart (marquee) |
- | * ** Japan Media ** (checkbox): If this option is checked ARRM recovers the Japanese media of the game (only on Screenscraper). | ||
- | |||
- | * ** US Media ** (checkbox): If this option is checked ARRM recovers the US meida of the game (only on Screenscraper). The text will be that of the ARRM interface. | ||
- | | + | __ ** Force Media Download |
- | * ** SS Media ** (checkbox): If this option is checked ARRM recovers the media created by ScreenScraper (non official) (only on Screenscraper). The text will be that of the ARRM interface. | ||
- | If US Media, | + | If you want to force the recovery of other media/tags during the scrape, you must force their recovery by checking the desired media below. (They will also be written in the gamelist) |
+ | |||
+ | {{ARRM: | ||
+ | |||
+ | |||
+ | * ** Get the video (video TAG) ** (checkbox): If checked, during the scrape, ARRM also download the video of the game (only on Screencraper) that it places in the videos directory of the scraped system. | ||
+ | |||
+ | * ** Get the Manual ** (checkbox): If checked, when scraping, ARRM also retrieves the game manual (the priority of languages and those of textual media) (only on Screencraper) which it places in the directory of scraped system manuals. This feeds the ' | ||
+ | |||
+ | * ** Get the Map ** (checkbox): If checked, when scraping, ARRM also retrieves the game's Map (if existing) (only on Screencraper) which it places in the Maps directory of the scraped system. This feeds the ' | ||
+ | |||
+ | * ** Get the Fanart ** (checkbox): If checked, when scraping, ARRM also retrieves the game's Fanart (if existing) | ||
+ | |||
+ | * ** Get the Titleshot ** (checkbox): If checked, when scraping, ARRM also retrieves the Titleshot of the game (if existing) which it places in the Titleshot directory of the scraped system. This feeds the ' | ||
+ | |||
+ | * ** Get the Boxback ** (checkbox): If checked, when scraping, ARRM also retrieves the Boxback (2D back side of the boxart) of the game (if existing) | ||
+ | |||
+ | * ** Get the Extra1 ** (checkbox): If checked, when scraping, ARRM also retrieves the media corresponding to the Extra1 tag defined in '** Media assignment' | ||
+ | |||
+ | * **Round Wheel (HFSDB / Screenscraper)** (checkbox): <color # | ||
+ | |||
+ | * ** Hyperspin Theme ** (checkbox): If checked, when scraping, ARRM also retrieves the Hyperspin Theme as a .zip file (only on Screencraper) which it places in the theme directory of the scraped system. There is no tag in the gamelist for the hyperspin ' | ||
+ | |||
+ | |||
+ | * ** Get the Screenshot ** (checkbox): If checked, when scraping, ARRM also retrieves the Screenshot of the game (if existing) (only on Screencraper) which it places in the Screenshot directory of the scraped system. This feeds the ' | ||
+ | |||
+ | * ** Get the Boxart ** (checkbox): If checked, when scraping, ARRM also retrieves the Boxart of the game (if existing) (only on Screencraper) which it places in the Boxart directory of the scraped system. This feeds the ' | ||
+ | |||
+ | * ** Get the Wheel ** (checkbox): If checked, when scraping, ARRM also retrieves the game's Wheel (if existing) (only on Screencraper) which it places in the Wheel directory of the scraped system. This feeds the ' | ||
+ | |||
+ | * ** Get the Cartridge ** (checkbox): If checked, during the scrape, ARRM also recovers the Game Cartridge (if existing) (only on Screencraper) which it places in the Cartridge directory of the scraped system. This feeds the ' | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | |||
+ | |||
+ | * ** Overlays ** (checkbox): If checked, ARRM retrieves | ||
+ | * ** {{: | ||
+ | * ** Dev ** (checkbox): Allows you to recover an overlay image with the viewport area detected by Arrm surrounded by yellow. This will detect and correct overlay errors. | ||
+ | * ** Custom ** (checkbox): Prioritize custom overlays (cus). It is advisable to activate this option because custom overlays often correct certain transparency problems. | ||
+ | * ** 4/3 ** (radio button): Only recover overlays in 4/3 format (native resolution on Screenscraper: | ||
+ | * ** -> 1280x1024 ** (checkbox): convert the recovered 4/3 overlays to a resolution of 1280x1024 | ||
+ | * ** 16/9 ** (radio button): Only recover overlays in 16/9 format native (resolution on Screenscraper: | ||
+ | * ** -> 720 ** (checkbox): Convert the recovered 16/9 overlays to a resolution of 1280x720 | ||
+ | |||
+ | The coordinates of the viewports are calculated according to the resolutions chosen. These options also apply to the recovery of system overlays. | ||
+ | |||
+ | |||
+ | * ** Delete unused images files ** (button): Erase all images from the current system folder not associated with a Rom file in the gamelist.xml. If several systems are selected, the deletion will be done on the media folders of each system. | ||
+ | |||
+ | |||
+ | * ** Default Image + Video ** (button): (<color # | ||
+ | |||
+ | {{ARRM: | ||
+ | |||
+ | < | ||
---- | ---- | ||
Ligne 181: | Ligne 438: | ||
* ** Remove sortname tag** (checkbox): doesn' | * ** Remove sortname tag** (checkbox): doesn' | ||
- | | + | < |
+ | |||
+ | * ** XML in uppercase ** (checkbox): When saving the gamelist.xml the fields ** Game name **, ** Description **, ** Developer **, ** Publisher **, ** Genre ** are capitalized. | ||
+ | |||
+ | <note warning> | ||
+ | To go back to lower case you will have to re-scrape the textual information. | ||
+ | </ | ||
+ | |||
+ | * ** Add the ' | ||
+ | |||
+ | * ** Core / Emulator per game ** (checkbox): On Batocera, allows saving the core / emulator per game in a text file located in **%appdata%\Nexouille soft\arrm\temp\batocera.conf\batocera.conf.%system%.txt**. | ||
+ | It will suffice to copy the lines of this file into your batocera.conf file. | ||
+ | Click on the {{: | ||
+ | |||
+ | * ** Retroarch Surcharge ** (checkbox): On Recalbox, the forcing of Emulators / Cores can be done via a Retroarch overload. See [[emulator_core_en# | ||
+ | |||
+ | | ||
* ** Auto Save Gamelist ** (checkbox): Automatically backs up the entire current gamelist.xml file during a system change, when you exit the application or when you click ' | * ** Auto Save Gamelist ** (checkbox): Automatically backs up the entire current gamelist.xml file during a system change, when you exit the application or when you click ' | ||
Ligne 188: | Ligne 461: | ||
* ** Temporary Gamelist ** (checkbox): A gamelist_tempo.xml file is created during the progression of the scrape in the directory of the scraped system. Thus during a crash of the application it is possible to retrieve the information from this file the next time the system is loaded. | * ** Temporary Gamelist ** (checkbox): A gamelist_tempo.xml file is created during the progression of the scrape in the directory of the scraped system. Thus during a crash of the application it is possible to retrieve the information from this file the next time the system is loaded. | ||
+ | |||
+ | * ** ZIP gamelist.xml ** (checkbox): When creating the gamelist.xml a gamelist.zip file is created. | ||
+ | |||
+ | * ** ScummVM folders ** (checkbox): When creating gamelist.xml, | ||
+ | |||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | * **ARRM folders** (checkbox) : When saving the gamelist.xml, | ||
* ** Open created xml ** (checkbox): Open with, your default text editor, the file gamelist.xml after its backup / creation. | * ** Open created xml ** (checkbox): Open with, your default text editor, the file gamelist.xml after its backup / creation. | ||
- | * ** Backup all gamelists ** (button): Create a backup folder in each system | + | * ** Backup all gamelists ** (button): Create a backup folder in folder |
+ | |||
+ | ** Export gamelist as ** | ||
+ | |||
+ | See dedicated section : [[export_gamelist_en|Export gamelist in Hyperspin, Pegasus, AttractMode format]] | ||
+ | |||
+ | * ** Hyperspin ** (checkbox): When saving the gamelist.xml via the ' | ||
+ | |||
+ | Example of Hyperspin XML file for the snes (** snes.xml **): | ||
+ | |||
+ | < | ||
+ | <?xml version=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | <game name=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | <crc /> | ||
+ | </ | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | | ||
+ | __ ** <color # ed1c24> Since version 1882 beta 8 </ | ||
+ | |||
+ | |||
+ | * ** Pegasus ** (checkbox): When saving the gamelist.xml via the ' | ||
+ | |||
+ | * ** Pegasus ** (clickable link): Used to display the association used between the Pegasus TAGs and the TAGs from the gamelist.xml | ||
+ | |||
+ | {{arrm: options: pegasus_tags.png? | ||
+ | |||
+ | {{ youtube> | ||
+ | |||
+ | \\ | ||
+ | [[https:// | ||
+ | |||
+ | Example ** Pegasus ** ** metadata.txt ** file for the snes system | ||
+ | |||
+ | < | ||
+ | collection: snes | ||
+ | game: Bounty Bob Strikes Back | ||
+ | file: ./bounty bob strikes back! (usa).zip | ||
+ | developer: Big Five Software | ||
+ | publisher: Big Five Software | ||
+ | genre: Action | ||
+ | description: | ||
+ | Bounty Bob Strikes Back est la suite du jeu Miner 2049er et reprend le même gameplay. Cette version est le portage de la version initiale Atari 8-bits. L' | ||
+ | release: 1984-01-01 | ||
+ | players: 1-2 | ||
+ | x-id: | ||
+ | assets.boxfront: | ||
+ | assets.cartridge: | ||
+ | assets.marquee: | ||
+ | assets.screenshot: | ||
+ | assets.video: | ||
+ | assets.logo: | ||
+ | assets.background: | ||
+ | assets.music: | ||
+ | rating: 0.80 | ||
+ | </ | ||
+ | |||
+ | |||
+ | __ ** <color # ed1c24> Since version 1882 beta 8 </ | ||
+ | |||
+ | * ** AttractMode ** (checkbox): When saving the gamelist.xml via the ' | ||
+ | |||
+ | Example file ** AttractMode ** ** Super Nintendo Entertainment System.txt ** for the snes system | ||
+ | |||
+ | < | ||
+ | # | ||
+ | bounty bob strikes back! (usa); | ||
+ | </ | ||
+ | |||
+ | **<color #ed1c24> Since version 1899 beta 11 </ | ||
+ | |||
+ | * ** Edit AttractMode association ** (Button): Allows you to edit the file **%appdata%\nexouille soft\arrm\database\attractmode_association.txt ** which makes it possible to make the link between the directories of the ARRM systems and the AttractMode systems | ||
+ | |||
+ | |||
+ | * ** CSV ** (checkbox): When saving the gamelist.xml, | ||
+ | |||
+ | Sample file | ||
+ | |||
+ | < | ||
+ | Name; | ||
+ | 10-Yard Fight; | ||
+ | 1942; | ||
+ | 1944 : The Loop Master; | ||
+ | 19XX : The Warinst Destiny; | ||
+ | 2020 Super Baseball; | ||
+ | </ | ||
---- | ---- | ||
+ | ===== Gamelist Tags ===== | ||
+ | {{arrm: | ||
+ | |||
+ | Available since version <color # | ||
+ | |||
+ | This tab allows you to select the media TAGs that you want to appear in Gamelist.xml. \\ | ||
+ | When creating/ | ||
+ | |||
+ | If the associated media exists, the TAG will be written in the gamelist.xml when you click on the **Create gamelist.xml** button. | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | |||
+ | * **Provider Custom** (checkbox): Allows, when creating the gamelist.xml, | ||
+ | |||
+ | This file is made up as follows: | ||
+ | Tag name (your choice) | comment/ | ||
+ | |||
+ | example : | ||
+ | < | ||
+ | scraped_by|Nexusone13 | ||
+ | information|This pack was done by Nexusone13 | ||
+ | version|Updated on 01/31/2022 | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | |||
+ | When the gamelist.xml will be generated it will give: | ||
+ | |||
+ | < | ||
+ | <?xml version=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | | ||
+ | < | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ---- | ||
===== Batocera / Screenscraper / TGBD ===== | ===== Batocera / Screenscraper / TGBD ===== | ||
{{ARRM: | {{ARRM: | ||
- | * ** Batocera | + | * **Recalbox** (checkbox): Check if you use Recalbox. Used for some specifics |
- | * ** Retropie ** (checkbox): Check if you use Retropie. Used for some specificities of this system (script of stop/restart, es_systems.cfg file management, overlays | + | * **Retropie** (checkbox): Check if you use Retropie. Used for certain |
- | If Batocera | + | * **Batocera** (checkbox): Check if you use Batocera. Used for certain specificities of this system (management of certain systems, core list, stop/start script, management of overlays, etc.) |
+ | * **Retrobat** (checkbox): Check if you are using Retrobat. Used for some specifics of this system | ||
+ | * **Batocera Plus** (checkbox): Check if you use Batocera Plus. Used for some specifics of this system | ||
- | | + | < |
+ | \\ | ||
+ | \\ | ||
+ | If **Batocera** and **Retropie** are not checked, **Recalbox** is assumed as the selected Frontend.</ | ||
- | * ** TGBD Requests left ** (label): TheGamesDb API limits the number of requests to 1500 per user per month . You will see here the number of calls you have left. | ||
- | * ** Search limit TGDB ** (textbox): When TheGamesDB finds several results, the display will be limited to the specified number. | ||
- | * ** Auto search | + | * ** Search limit TGDB** (textbox): indicates |
+ | |||
+ | * ** Search limit Others ** (textbox): indicates | ||
- | * ** Preview images on TGDB ** (checkbox): | + | * ** Auto validation |
+ | * ** Exact search** (checkbox): performs an exact search on the name of the game. Example: With this option checked, a search on the name 'Grand Theft Auto' will only return the game 'Grand Thef Auto 'while with this option unchecked all Grand Theft Auto titles will be returned. Works on HFSDB, Lanchbox, GameTDB, SteamDB, GOG, IGDB | ||
+ | |||
+ | * **Ignore platform** (checkbox) : Allows not to filter on the platform when searching for a game. Works on TGDB, HFSDB, Launchbox, Gametdb, Igdb. | ||
+ | |||
+ | * ** Preview images on TGDB ** (checkbox): On the selection window of a game found on TheGameDB, display or not a thumbnail of the screenshot / title / boxart found. Be careful, this consumes API calls on TheGamesDB. | ||
+ | |||
+ | * ** TGBD Requests rest ** (label): TheGamesDb API limits the number of calls to 1500 requests per user per month. Here you will see the number of calls you have left. | ||
+ | | ||
* ** Stop EmulationStation ** (button): Before modifying your gamelist.xml it is necessary to stop the EmulationStation service. To do only if you work directly on the FrontEnd via a network share. Remember to check Batocera or Retropie if you are on this system because the scripts are different. | * ** Stop EmulationStation ** (button): Before modifying your gamelist.xml it is necessary to stop the EmulationStation service. To do only if you work directly on the FrontEnd via a network share. Remember to check Batocera or Retropie if you are on this system because the scripts are different. | ||
Ligne 223: | Ligne 672: | ||
* ** Login Screenscraper ** (button): Displays a popup to enter your username / password on screenscraper. It is preferable (but not mandatory) to create an account on Screenscraper.fr because it favors registered users during scrapes. | * ** Login Screenscraper ** (button): Displays a popup to enter your username / password on screenscraper. It is preferable (but not mandatory) to create an account on Screenscraper.fr because it favors registered users during scrapes. | ||
+ | |||
+ | {{ARRM: | ||
+ | |||
+ | Click on ' | ||
* **Login** (textbox): Login for SSH access on your Recalbox / Batocera / Retropie systems | * **Login** (textbox): Login for SSH access on your Recalbox / Batocera / Retropie systems | ||
Ligne 260: | Ligne 713: | ||
{{arrm: | {{arrm: | ||
- | ARRM uses the file ' | + | ARRM uses the file ' |
< | < | ||
Ligne 298: | Ligne 751: | ||
- | * ** Backup configuration files ** (button): Create a backup with the current date of the user-modifiable parameter files that are in this directory: ' | + | * ** Backup configuration files ** (button): Create a backup with the current date of the user-modifiable parameter files that are in this directory: ' |
- | * ** SpeedUp | + | * ** Web Request TimeOut (sec) ** (textbox): Sets the timeout for web requests |
- | * ** Web Request TimeOut | + | * < |
+ | |||
+ | * ** Get systems Wheels** (button): get, on Screenscraper, | ||
+ | |||
+ | * ** Add Flag ** (button): Adds flags to the image without having to re-scrape. The template selected must be the one originally used on the existing image and have the < | ||
+ | |||
+ | * ** Pad 2 Keyb **: By clicking on {{: | ||
+ | |||
+ | < | ||
+ | If you want to convert Recalbox .p2k files into Batocera compatible .keys files I invite you to use the [[https:// | ||
+ | </ | ||
+ | |||
+ | * ** Arcade systems list **: allows you to edit the List of systems to be considered as an Arcade system (**%appdata%\Nexouille Soft\Arrm\Database\arcade_systems_list.txt**). This list is used when loading gamelists as well as when checking arcade names. You can add here your arcade systems separated by a semicolon (;) . Restart ARRM when you modify this file. | ||
+ | |||
+ | {{arrm: | ||
+ | |||
+ | **<color # | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | __**Video Encoder**__ | ||
+ | |||
+ | * **Handbrake parameters** (textbox) : allows to modify handbrake video compression parameters. If empty, | ||
+ | |||
+ | * **FFmpeg parameters** (textbox): allows to modify the video compression parameters of FFmpeg. If empty, the following default values are applied: **-ac 1 -c:v libx264 -preset:v slow -profile:v main -level 3.1 -filter_complex “format=yuv420p, | ||
+ | |||
+ | \\ | ||
+ | You can try this other parameters for FFmpeg : | ||
+ | |||
+ | **-ac 1 -c:v libx264 -pix_fmt yuv420p -crf 35 -preset:v slow -y** | ||
+ | |||
+ | Other user setting **Fourch** which allows to keep the original duration, 60 fps, and have a quality equivalent to normalized videos, for almost the same weight. A little longer to encode but better quality: \\ | ||
+ | **-acodec libmp3lame -b:a 64k -ar 24000 -c:v libxvid -preset veryslow -crf 30 -vf " | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | |||
+ | * **Video+Overlay compress parameters** (textbox): allows to modify the video compression parameters of FFmpeg which will apply on video generated by ' | ||
+ | |||
+ | |||
+ | __**Image Encoder**__ | ||
* ** Pngequant parameters ** (textbox): allows to modify pngquant image compression parameters. If empty, the following default values are applied: --force --verbose --ordered --speed=1 --quality=30-90 --ext .png | * ** Pngequant parameters ** (textbox): allows to modify pngquant image compression parameters. If empty, the following default values are applied: --force --verbose --ordered --speed=1 --quality=30-90 --ext .png | ||
- | * **Handbrake parameters** (textbox) : allows to modify handbrake video compression parameters. If empty, the following default values are applied: -Z "Gmail Small 10 Minutes 288p30" | ||
- | | + | __**Convert Recalbox Overlays**__ |
- | * ** Compress selected videos ** (button): With this button | + | If you already have Recalbox overlays but you want to convert them in order to use them on Batocera. |
+ | ARRM offers | ||
- | * ** Best Arcade Core Update | + | * ** Overlays converted Folder |
- | + | ||
+ | < | ||
+ | |||
+ | * ** Recalbox Overlays Folders **: Indicate here the Overlays directory of ** Recalbox **. This can be **\\recalbox\share\overlays** or any other directory containing the ** overlays ** folder with the tree structure specific to the overlays ** Recalbox **. | ||
+ | |||
+ | * ** Copy PNG ** (checkbox) : Check it if you want to copy overlays .PNG files, otherwise only the .info will be created | ||
+ | |||
+ | * **Convert to BATOCERA ** (button) : launch the conversion of Recalbox overlays configuration files to Batocera overlay configuration files (.info) | ||
+ | When the conversion is complete, you can access the ** Overlays converted Folder ** directory by clicking on {{: {{: | ||
+ | |||
+ | |||
+ | < | ||
+ | Remember to copy the content into \\batocera\share\decorations\**your_overlays_folders** | ||
+ | </ | ||
+ | |||
+ | |||
+ | __**Parameter File**__ | ||
+ | |||
+ | **<color # | ||
+ | |||
+ | You can view and modify ARRM configuration files. By clicking on a file you have its description. Clicking on {{: | ||
+ | |||
+ | <note important> | ||
+ | After modifying configuration files, it is necessary, to avoid any problem, to restart ARRM. </ | ||
+ | |||
+ | |||
+ | * ** Create empty Rom file when no exists (Dev) ** (checkbox): **<color # | ||
---- | ---- | ||
+ | ===== Update ===== | ||
+ | Available since version <color # | ||
+ | Regularly files are updated.\\ | ||
+ | If you want to take advantage of it without having to wait for a final version, you can go through the **Update** tab | ||
+ | |||
+ | The last update date of a file is displayed after the file name in **yyyy/ | ||
+ | |||
+ | {{arrm: | ||
+ | |||
+ | This tab allows you to update various ARRM configuration files: | ||
+ | |||
+ | |||
+ | * **Update LaunchBox DB**: the media and information offered by LaunchBox are regularly updated by the community. It is therefore necessary to update LaunchBox on ARRM. An update is offered with each new version of ARRM, included in the application zip. But between two versions you will have to do this update via this button. The last update date is in mm/dd/yyyy format | ||
+ | |||
+ | * **Update Steam DB**: the media and information offered by Steam are regularly updated (addition of new games etc...). It is therefore necessary to do a Steam DB update on ARRM. An update is offered with each new version of ARRM, included in the application zip. But between two versions you will have to do this update via this button. The last update date is in mm/dd/yyyy format | ||
+ | |||
+ | * **Configurations files**: Select the files you want to update then click on the **Update** button. The old file will be renamed to .old as a precaution. These configuration files offered with each new version of ARRM, included in the zip of the application. But between two versions you will have to do this update via this button. | ||
+ | |||
+ | * **DAT to Database**: To update the search database by Datfiles. The treatment can be very long. See wiki for the procedure: [[rename_game_with_datfiles_fr# | ||
+ | |||
+ | * **ARCADE to Database**: To update the search database by Datfiles on **Arcade** systems. It is used in the ' | ||
+ | |||
+ | ---- | ||
===== Contact ===== | ===== Contact ===== | ||
Ligne 331: | Ligne 873: | ||
* [[nexusone13@gmail.com? | * [[nexusone13@gmail.com? | ||
* [[http:// | * [[http:// | ||
- | * Link to access the [[http:// | + | * Link to access the [[http:// |
- | * Link to [[https:// | + | * Links to make a donation |
* Link to access this [http:// | * Link to access this [http:// | ||
+ | * ** Send debug info to developer ** (button): If you encounter a bug or an unexpected behavior of ARRM, click on this button to automatically send by email to the developer, a log of your ARRM config and last report scrape. | ||
---- | ---- |
settings-en.1573163941.txt.gz · Dernière modification : 2019/11/07 22:59 de nexusone13