Français
General
Scrape
Template
Gestion de Roms
Gamelist
- Sauvegarde du gamelist.xml
Outils
Divers
English
General
Scrape
Template
Roms management
Gamelist
- Saving the gamelist.xml
Tools
Miscellaneous
General
Scrape
Template
Gestion de Roms
Gamelist
Outils
Divers
General
Scrape
Template
Roms management
Gamelist
Tools
Miscellaneous
ARRM allows you to create your own templates that you can use during your scraps using the ' Mix ' mode in ' Images Options '.
A template must be placed in the directory: %appdata%\roaming\Nexouille Soft\arrm\ressources\templates\template_name
The name given to the directory (template_name) is free of choice.
Be careful, if you create templates, use new directory names otherwise they will be removed during an uninstallation of the application during the update process.
This directory (template_name) must contain the following file: - an .xml file containing the definition of the template (see code below)
It is advisable to also have the file sample .png (below) which will display the preview of the template in the template selection module - a sample .png file which contains a preview of the final template (to be retrieved on a scrap mix done with this template).
Other .png files that will constitute your template can be added, in this directory (example background.png, console.png, foreground.png etc …)
Here is an example of an .xml file, which you will have to adapt according to the template you wish to make. This corresponds to the template ' mix_arcade_red_profile_v2.xml ' available in the directory %appdata%\roaming\Nexouille Soft\arrm\ressources\templates\mix_arcade_red_profile _v2
<?xml version="1.0" encoding="utf-8" ?> <data> <infos> <author>author's name</author> <description>template's description</description> </infos> <element> <name>Arcade Red profile V2</name> <sample>sample_mix_arcade_red_profile_v2.png</sample> <commentaire>edit custom xml to remove boxart</commentaire> <type>profile</type> <box>true</box> <marquee>true</marquee> <add_black_borders>true</add_black_borders> <custom_background_width>635</custom_background_width> <custom_background_height>745</custom_background_height> <custom_screenshot_ulx>105</custom_screenshot_ulx> <custom_screenshot_uly>250</custom_screenshot_uly> <custom_screenshot_urx>442</custom_screenshot_urx> <custom_screenshot_ury>254</custom_screenshot_ury> <custom_screenshot_llx>121</custom_screenshot_llx> <custom_screenshot_lly>471</custom_screenshot_lly> <custom_screenshot_lrx>449</custom_screenshot_lrx> <custom_screenshot_lry>451</custom_screenshot_lry> <custom_screenshot_width>337</custom_screenshot_width> <custom_screenshot_height>217</custom_screenshot_height> <custom_boxart_x>25</custom_boxart_x> <custom_boxart_y>440</custom_boxart_y> <custom_boxart_width>250</custom_boxart_width> <custom_boxart_height>300</custom_boxart_height> <custom_marquee_ulx>144</custom_marquee_ulx> <custom_marquee_uly>36</custom_marquee_uly> <custom_marquee_urx>522</custom_marquee_urx> <custom_marquee_ury>77</custom_marquee_ury> <custom_marquee_llx>141</custom_marquee_llx> <custom_marquee_lly>155</custom_marquee_lly> <custom_marquee_lrx>523</custom_marquee_lrx> <custom_marquee_lry>178</custom_marquee_lry> <custom_marquee_width>378</custom_marquee_width> <custom_marquee_height>119</custom_marquee_height> <custom_marquee2_ulx>277</custom_marquee2_ulx> <custom_marquee2_uly>545</custom_marquee2_uly> <custom_marquee2_urx>628</custom_marquee2_urx> <custom_marquee2_ury>545</custom_marquee2_ury> <custom_marquee2_llx>277</custom_marquee2_llx> <custom_marquee2_lly>729</custom_marquee2_lly> <custom_marquee2_lrx>628</custom_marquee2_lrx> <custom_marquee2_lry>729</custom_marquee2_lry> <custom_marquee2_width>352</custom_marquee2_width> <custom_marquee2_height>185</custom_marquee2_height> <layer1>background.png</layer1> <layer2>screenshot</layer2> <layer3>foreground.png</layer3> <layer4>boxart</layer4> <layer5>marquee</layer5> <layer6>marquee2</layer6> <layer7></layer7> <layer8></layer8> <layer9></layer9> <layer10></layer10> </element> </data>
Another example of an .xml file, usable since the ARRM version 1.7.7.5 which allows to manage differently the display of boxarts according to their format (portrait, landscape (style N64), CD), managed by the tags:
Example with the template file ' Next_Pixel_1080_console.xml ' available in the directory %appdata%\roaming\Nexouille Soft\arrm\ressources\templates\Next_Pixel_1080_console
<?xml version="1.0" encoding="utf-8"?> <data> <infos> <author>Franck Pouilly</author> <description>Template for NextPixel : CONSOLES snes,gx4000,jaguar,megadrive,neogeo,pcengine,n64,satellaview,sega32x,sufami,3do,amigacd32,dreamcast,gc,neogeocd,pcenginecd,pcfx,ps2,psx,saturn,segacd,supergrafx</description> </infos> <element> <name>Next_Pixel_1080_console</name> <sample>sample_next_pixel_1080_console.png</sample> <box>true</box> <marquee>true</marquee> <add_black_borders>true</add_black_borders> <custom_background_width>1260</custom_background_width> <custom_background_height>1080</custom_background_height> <custom_screenshot_x>400</custom_screenshot_x> <custom_screenshot_y>143</custom_screenshot_y> <custom_screenshot_width>640</custom_screenshot_width> <custom_screenshot_height>480</custom_screenshot_height> <custom_marquee_x>599</custom_marquee_x> <custom_marquee_y>712</custom_marquee_y> <custom_marquee_width>653</custom_marquee_width> <custom_marquee_height>328</custom_marquee_height> <custom_boxart_x>9</custom_boxart_x> <custom_boxart_y>432</custom_boxart_y> <custom_boxart_width>339</custom_boxart_width> <custom_boxart_height>625</custom_boxart_height> <custom_cartridge_x>342</custom_cartridge_x> <custom_cartridge_y>829</custom_cartridge_y> <custom_cartridge_width>214</custom_cartridge_width> <custom_cartridge_height>214</custom_cartridge_height> <item boxart="portrait"> <custom_boxart_x>9</custom_boxart_x> <custom_boxart_y>432</custom_boxart_y> <custom_boxart_width>339</custom_boxart_width> <custom_boxart_height>625</custom_boxart_height> <custom_cartridge_x>342</custom_cartridge_x> <custom_cartridge_y>829</custom_cartridge_y> <custom_cartridge_width>214</custom_cartridge_width> <custom_cartridge_height>214</custom_cartridge_height> </item> <item boxart="landscape"> <custom_boxart_x>6</custom_boxart_x> <custom_boxart_y>726</custom_boxart_y> <custom_boxart_width>500</custom_boxart_width> <custom_boxart_height>271</custom_boxart_height> <custom_cartridge_x>65</custom_cartridge_x> <custom_cartridge_y>546</custom_cartridge_y> <custom_cartridge_width>277</custom_cartridge_width> <custom_cartridge_height>178</custom_cartridge_height> </item> <item boxart="cd"> <custom_boxart_x>2</custom_boxart_x> <custom_boxart_y>593</custom_boxart_y> <custom_boxart_width>365</custom_boxart_width> <custom_boxart_height>489</custom_boxart_height> <custom_cartridge_x>288</custom_cartridge_x> <custom_cartridge_y>800</custom_cartridge_y> <custom_cartridge_width>271</custom_cartridge_width> <custom_cartridge_height>271</custom_cartridge_height> </item> <resize width = "630" height = "540" /> <layer1>console.png</layer1> <layer2>screenshot</layer2> <layer3>boxart</layer3> <layer4>marquee</layer4> <layer5>cartridge</layer5> <layer7 /> <layer8 /> <layer9 /> <layer10 /> </element> </data>
<name> Name of the template. It will be displayed in the mix selection
<sample> name of the png file containing the sample of the final template. It will be displayed in the mix selection
<comment> Informative commentary \\
<type> put profile (<type>profile</type>)
<box> put true (<box>true</box>), if you want to display the boxart, otherwise false
<marquee> set true (<marquee>true</marquee>), if you want to display the marquee (title), else false
Size of you final Mix image
<custom_background_width> total width of your template image
<custom_background_height> total height of your template image
SCREENSHOT
Details of the screenshot that will be displayed in the template. The screenshot area is shown in yellow in the image below with green coordinates
<custom_screenshot_ulx> X coordinate of the point at the top left of the screenshot in your template <custom_screenshot_uly> Y coordinate of the point at the top left of the screenshot in your template <custom_screenshot_urx> X coordinate of the point at the top right of the screenshot in your template <custom_screenshot_ury> Y coordinate of the point at the top right of the screenshot in your template <custom_screenshot_llx> X coordinate of the point at the bottom left of the screenshot in your template <custom_screenshot_lly> Y coordinate of the point at the bottom left of the screenshot in your template <custom_screenshot_lrx> X coordinate of the point at the bottom right of the screenshot in your template <custom_screenshot_lry> Y coordinate of the point at the bottom right of the screenshot in your template
Size of the screenshot
<custom_screenshot_width> is the width of the screenshot in the template (calculation: <custom_screenshot_urx> - <custom_screenshot_ulx>)
<custom_screenshot_height> is the height of the screenshot in the template (calculation: <custom_screenshot_lly> - <custom_screenshot_uly>)
BOXART
Contact details of the Boxart The Boxart area is shown in blue on the image below with green coordinates
<custom_boxart_x> is the X coordinate of the Boxart
<custom_boxart_y> is the Y coordinate of the Boxart
Boxart size
<custom_boxart_width> is the width of the Boxart
<custom_boxart_height> corresponds to the height of the Boxart, Be careful that (custom_boxart_y + custom_boxart_height) is not> to custom_background_height otherwise the boxart would come out of the screen.
<item boxart="portrait"> <custom_boxart_x>0</custom_boxart_x> <custom_boxart_y>240</custom_boxart_y> <custom_boxart_width>360</custom_boxart_width> <custom_boxart_height>360</custom_boxart_height> <custom_cartridge_x>160</custom_cartridge_x> <custom_cartridge_y>410</custom_cartridge_y> <custom_cartridge_width>160</custom_cartridge_width> <custom_cartridge_height>160</custom_cartridge_height> </item> <item boxart="landscape"> <custom_boxart_x>0</custom_boxart_x> <custom_boxart_y>240</custom_boxart_y> <custom_boxart_width>360</custom_boxart_width> <custom_boxart_height>360</custom_boxart_height> <custom_cartridge_x>40</custom_cartridge_x> <custom_cartridge_y>260</custom_cartridge_y> <custom_cartridge_width>160</custom_cartridge_width> <custom_cartridge_height>160</custom_cartridge_height> </item> <item boxart="cd"> <custom_boxart_x>0</custom_boxart_x> <custom_boxart_y>240</custom_boxart_y> <custom_boxart_width>360</custom_boxart_width> <custom_boxart_height>360</custom_boxart_height> <custom_cartridge_x>160</custom_cartridge_x> <custom_cartridge_y>410</custom_cartridge_y> <custom_cartridge_width>160</custom_cartridge_width> <custom_cartridge_height>160</custom_cartridge_height> </item>
MARQUEE
Contact details of the Marquee
The Marquee area is shown in yellow in the image below with green coordinates
<custom_marquee_ulx> X coordinate of the point at the top left of the marquee in your template
<custom_marquee_uly> Y coordinate of the point at the top left of the marquee in your template
<custom_marquee_urx> X coordinate of the point at the top right of the marquee in your template
<custom_marquee_ury> Y coordinate of the point at the top right of the marquee in your template
<custom_marquee_llx> X coordinate of the point at the bottom left of the marquee in your template
<custom_marquee_lly> Y coordinate of the point at the bottom left of the marquee in your template
<custom_marquee_lrx> X coordinate of the point at the bottom right of the marquee in your template
<custom_marquee_lry> Y coordinate of the point at the bottom right of the marquee in your template
Size of the Marquee
<custom_marquee_width> is the width of the marquee in the template (calculation: <custom_marquee_urx> - <custom_marquee_ulx>)
<custom_marquee_height> is the height of the marquee in the template (calculation: <custom_marquee_lly> - <custom_marquee_uly>)
MARQUEE2
It is possible to display a 2nd Marquee at another place in the image. Same principle as the MARQUEE
In this case, add the following lines:
<custom_marquee2_ulx> X coordinate of the point at the top left of marquee2 in your template
<custom_marquee2_uly> Y coordinate of the point at the top left of marquee2 in your template
<custom_marquee2_urx> X coordinate of the point at the top right of marquee2 in your template
<custom_marquee2_ury> Y coordinate of the point at the top right of marquee2 in your template
<custom_marquee2_llx> X coordinate of the point at the bottom left of the marquee2 in your template
<custom_marquee2_lly> Y coordinate of the point at the bottom left of the marquee2 in your template
<custom_marquee2_lrx> X coordinate of the point at the bottom right of the marquee2 in your template
<custom_marquee2_lry> Y coordinate of the point at the bottom right of marquee2 in your template
<custom_marquee2_width> is the width of marquee2 in the template (calculation: <custom_marquee2_urx> - <custom_marquee2_ulx>)
<custom_marquee2_height> is the height of marquee2 in the template (calculation: <custom_marquee2_lly> - <custom_marquee2_uly>)
FANART
Coordinates of FANART
<custom_fanart_ulx> X coordinate of the point at the top left of fanart in your template
<custom_fanart_uly> Y coordinate of the point at the top left of fanart in your template
<custom_fanart_urx> X coordinate of the point at the top right of fanart in your template
<custom_fanart_ury> Y coordinate of the point at the top right of fanart in your template
<custom_fanart_llx> X coordinate of the point at the bottom left of the fanart in your template
<custom_fanart_lly> Y coordinate of the point at the bottom left of the fanart in your template
<custom_fanart_lrx> X coordinate of the point at the bottom right of the fanart in your template
<custom_fanart_lry> Y coordinate of the point at the bottom right of fanart in your template
Size of fanart
<custom_fanart_width> is the width of fanart in the template (calculation: <custom_fanart_urx> - <custom_fanart_ulx>)
<custom_fanart_height> is the height of fanart in the template (calculation: <custom_fanart_lly> - <custom_fanart_uly>)
TITLESHOT
Coordinates of TITLESHOT
<custom_titleshot_ulx> X coordinate of the point at the top left of titleshot in your template
<custom_titleshot_uly> Y coordinate of the point at the top left of titleshot in your template
<custom_titleshot_urx> X coordinate of the point at the top right of titleshot in your template
<custom_titleshot_ury> Y coordinate of the point at the top right of titleshot in your template
<custom_titleshot_llx> X coordinate of the point at the bottom left of the titleshot in your template
<custom_titleshot_lly> Y coordinate of the point at the bottom left of the titleshot in your template
<custom_titleshot_lrx> X coordinate of the point at the bottom right of the titleshot in your template
<custom_titleshot_lry> Y coordinate of the point at the bottom right of titleshot in your template
Size of titleshot
<custom_titleshot_width> is the width of titleshot in the template (calculation: <custom_titleshot_urx> - <custom_titleshot_ulx>)
<custom_titleshot_height> is the height of titleshot in the template (calculation: <custom_titleshot_lly> - <custom_titleshot_uly>)
CARTRIDGE
Cartridge coordinates (same principle as Boxart)
<custom_cartridge_x> is the X coordinate of the cartridge
<custom_cartridge_y> is the Y coordinate of the cartridge
Cartridge Size
<custom_cartridge_width> is the width of the cartridge
<custom_cartridge_height> is the height of the cartridge, Be careful that (custom_cartridge_y + custom_cartridge_height) is not> to custom_background_height otherwise the cartridge would come out of the screen.
<item cartridge="portrait"> <custom_cartridge_x>160</custom_cartridge_x> <custom_cartridge_y>410</custom_cartridge_y> <custom_cartridge_width>160</custom_cartridge_width> <custom_cartridge_height>160</custom_cartridge_height> </item> <item cartridge="landscape"> <custom_cartridge_x>40</custom_cartridge_x> <custom_cartridge_y>260</custom_cartridge_y> <custom_cartridge_width>160</custom_cartridge_width> <custom_cartridge_height>160</custom_cartridge_height> </item> <item cartridge="cd"> <custom_cartridge_x>160</custom_cartridge_x> <custom_cartridge_y>410</custom_cartridge_y> <custom_cartridge_width>200</custom_cartridge_width> <custom_cartridge_height>200</custom_cartridge_height> </item>
BOXBACK (from version 1882 beta 11)
BoxBack coordinates (same principle as Boxart)
<custom_boxback_x> matches the X coordinate of the cartridge
<custom_boxback_y> corresponds to the Y coordinate of the cartridge
BoxBack Size
<custom_boxback_width> corresponds to the width of the BoxBack
<custom_boxback_height> corresponds to the height of the BoxBack, Be careful that (custom_boxback_y + custom_boxback_height) are not> at custom_background_height otherwise the BoxBack will exit the screen.
<item boxback="portrait"> <custom_boxback_x>0</custom_boxback_x> <custom_boxback_y>240</custom_boxback_y> <custom_boxback_width>360</custom_boxback_width> <custom_boxback_height>360</custom_boxback_height> </item> <item boxback="landscape"> <custom_boxback_x>0</custom_boxback_x> <custom_boxback_y>240</custom_boxback_y> <custom_boxback_width>360</custom_boxback_width> <custom_boxback_height>360</custom_boxback_height> </item> <item boxback="cd"> <custom_boxback_x>0</custom_boxback_x> <custom_boxback_y>240</custom_boxback_y> <custom_boxback_width>360</custom_boxback_width> <custom_boxback_height>360</custom_boxback_height> </item>
<resize width = “630” height = “540” /> tells ARRM (since version 1.7.7.6) to resize the mix with a width of 630px and a height of 540px
DEFINITION OF LAYERS
ARRM can combine 10 layers, which are a stack from the bottom most layer (layer1) to the front most (layer10).
All layers are not necessarily filled in, as in the example given. A layer can contain a .png image file located in the template directory, or one of the following tags:
In the example, the background consists of the black screen of the Arcade cabinet.
In the example, the foreground consists of the Arcade cabinet. (the area of the screen is in transparent mode)
In the xml code below, we see that the background (the black screen) is first displayed, then comes the screenshot and then the foreground (the Arcade cabinet). Layers 4, 5, and 6 will be in the foreground.
<layer1>background.png</layer1> <layer2>screenshot</layer2> <layer3>foreground.png</layer3> <layer4>boxart</layer4> <layer5>marquee</layer5> <layer6>marquee2</layer6> <layer7></layer7> <layer8></layer8> <layer9></layer9> <layer10></layer10>
Feel free to study the available templates, including those with an integration of the cartridge inserted into the console (mix_atari_2600_cartridge, mix_snes …) that will allow you to understand how to use the layers.
If you create templates, do not hesitate to send them to me by Mail, I will put them for download on JujuVinceBros' website in section Template for ARRM, in order to share it with other ARRM users.