Outils pour utilisateurs

Outils du site


Panneau latéral

Français


English

create_template-en

Create your own template for ARRM

ARRM allows you to create your own templates that you can use during your scraps using the ' Mix ' mode in ' Images Options '.


Template directory

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).

sample_mix_arcade_red_profile_v2.png

Other .png files that will constitute your template can be added, in this directory (example background.png, console.png, foreground.png etc …)

background.png foreground.png


Template configuration .xml file

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>


Description of the tags

<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>)

screenshot




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.

boxart




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>)

marquee




MARQUEE 2

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>)




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.




DEFINITION OF LAYERS

ARRM can combine 10 layers, which are a stack from the deepest layer (layer1) to the most forwardmost layer (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:

  • screenshot
  • boxart
  • marquee
  • marquee2 (if the mark is displayed on a 2nd position)
  • cartridge

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>



Share your creations

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.

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.

create_template-en.txt · Dernière modification: 2019/05/12 10:47 par nexusone13