Difference between revisions of "Arma 3 Mod Presentation"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (file Mod.cpp: corrected more typos)
m (Text replacement - " it's" to " it is")
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Stub}}
+
{{SideTOC}}
 +
{{Informative|There are similarities to presenting a (Creator) DLC and a mod. Although not all DLC techniques apply to mods, find details and configuration samples [[Arma_3_DLC_Content_Licensing|here]].}}
  
 +
{|
 +
| style="vertical-align: top" | A mod is generally a batch of files that constitute a consistent list of additions, but not limited to. A mod can have its very own presentation as shown.
 +
| [[File:modPresentationMainMenu.jpg|300px]]
 +
|-
 +
| style="vertical-align: top" | Your mod is also present in the Expansions menu with a larger picture and a long description of its content or context, it is up to you. This also include a link to your website.
 +
| [[File:modPresentationExpansionsMenu.jpg|300px]]
 +
|-
 +
| colspan="2" |
 +
|-
 +
| style="vertical-align: top" | '''Last but not least, you have the possibility to display an icon next to the content your mod adds or alters in [[Eden Editor]] interface.'''
 +
In this screen, the kart object has the [[Arma 3 Karts|Karts DLC]] icon of the to which it belongs to.
 +
| [[File:modPresentationeditorList.jpg|300px]]
 +
|-
 +
| style="vertical-align: top" | In this screen though, a map has the DLC logo, but this time, [[Altis]] also has it because the mod uses or alters it.
 +
| [[File:modPresentationMaps.jpg|300px]]
 +
|}
  
== Foreword ==
+
''A sample may be added in [[:Category:Arma_3:_Official_Tools|Arma 3 Tools]], meanwhile, you can access the sources [http://tom4897.info/?attachment_id=2876 here], a demo [http://tom4897.info/?attachment_id=2875 here], and more information on DLC presentation [[Arma_3_DLC_Content_Licensing|here]].''
A mod is generally a batch of files that constitute a consistent list of additions, but not limited to. A mod can have its very own presentation like shown in the screen below
 
  
[[File:modPresentationMainMenu.jpg|500px]]
 
  
Your mod is also present in the Expansions menu (next screen) with a larger picture and a long description of its content or context, it's up to you. This also include a link to you website.
+
== How to ==
  
[[File:modPresentationExpansionsMenu.jpg|500px]]
+
=== file Mod.cpp ===
  
Last but not least, is about the editor, you have the possibility to display an icon next to the content your mod adds or alters. In the left screen, the Kart has the icon of the Karts DLC to which it belongs to, then, in the left screen, you can see a map with the logo, but this time, Atlis has also the logo because the mod uses or alters it.
+
This is the definition file, it must be place in the root folder of your mod (''Arma 3\Splendid Mod\mod.cpp'') and can contain:
 +
<syntaxhighlight lang="cpp">
 +
name = "Splendid mod"; // Name of your mod
 +
picture = "\Samples_F\Data_01\Images\picture.paa"; // Picture displayed from the expansions menu. Optimal size is 2048x1024
 +
logoSmall = "\Samples_F\Data_01\Logos\logo_small.paa"; // Display next to the item added by the mod
 +
logo = "\Samples_F\Data_01\Logos\logo.paa"; // Logo displayed in the main menu
 +
logoOver = "\Samples_F\Data_01\Logos\logoOver.paa"; // When the mouse is over, in the main menu
 +
action = "https://example.org/my-mod-page"; // Website URL, that can accessed from the expansions menu
 +
tooltipOwned = "It's yours!"; // Tool tip displayed when the mouse is left over, in the main menu
  
[[File:modPresentationeditorList.jpg|250px]] [[File:modPresentationMaps.jpg|250px]]
+
// Color used for DLC stripes and backgrounds (RGBA)
 +
dlcColor[] =
 +
{
 +
0.23,
 +
0.39,
 +
0.30,
 +
1
 +
};
 +
// Overview text, displayed from the extension menu
 +
overview = "Unleash your creativity! Here goes the long description of your mod.";
 +
hideName = 0; // Hide the extension name
 +
hidePicture = 0; // Hide the extension menu
 +
</syntaxhighlight>
  
''A sample will be added soon in [[:Category:Arma_3_Official_Tools|Arma 3 Tools]], meanwhile, you can access the sources [http://tom4897.info/?attachment_id=2876 here] and a demo [http://tom4897.info/?attachment_id=2875 here]''
+
=== Images ===
  
== How to ==
 
=== file Mod.cpp ===
 
This is the definition file, it must be place in the root folder of your mod (''Arma 3\Splendid Mod\mod.cpp'') and can contain:
 
{{codecomment|/// Name of your mod}}
 
name = "Splendid mod";
 
{{codecomment|/// Picture displayed from the expansions menu}}
 
picture = "\Samples_F\Data_01\Images\picture.paa";
 
{{codecomment|/// Display next to the item added by the mod}}
 
logoSmall = "\Samples_F\Data_01\Logos\logo_small.paa";
 
{{codecomment|/// Logo displayed in the main menu}}
 
logo = "\Samples_F\Data_01\Logos\logo.paa";
 
{{codecomment|/// When the mouse is over, in the main menu}}
 
logoOver = "\Samples_F\Data_01\Logos\logoOver.paa";
 
{{codecomment|/// Website URL, that can accessed from the expansions menu}}
 
action = "https://community.bistudio.com/wiki/Mod_Presentation";
 
{{codecomment|/// Tool tip displayed when the mouse is left over, in the main menu}}
 
tooltipOwned = "It's yours!";
 
{{codecomment|/// Color used for DLC stripes and backgrounds (RGBA)}}
 
dlcColor[] =
 
{
 
0.23,
 
0.39,
 
0.30,
 
1
 
};
 
{{codecomment|/// Overview text, displayed from the extension menu}}
 
overview = "Unleash your creativity! Here goes the long description of your mod.";
 
{{codecomment|/// Hide the extension name }}
 
hideName = 0;
 
{{codecomment|/// Hide the extension menu}}
 
hidePicture = 0;
 
 
=== Images ===
 
 
The images defined in the mod.cpp can be stored, either, individually in the mod directory or in a packed pbo.
 
The images defined in the mod.cpp can be stored, either, individually in the mod directory or in a packed pbo.
  
Line 57: Line 59:
 
If you opt for a packed data, you will have to put your images in a PBO and point the image path like in any other addon (the example of mod.cpp is based on packed file (PBO) which has for prefix "Samples_F").
 
If you opt for a packed data, you will have to put your images in a PBO and point the image path like in any other addon (the example of mod.cpp is based on packed file (PBO) which has for prefix "Samples_F").
  
[[Category: Arma 3: Editing]]
+
==== Recommended sizes ====
 +
{| class = "wikitable"
 +
! Type !! A !! x !! B
 +
|-
 +
| '''Logo''' || 128 || x || 128
 +
|-
 +
| '''LogoOver''' || 128 || x || 128
 +
|-
 +
| '''LogoSmall''' || 64 || x || 64
 +
|-
 +
| '''Picture''' || 2048 || x || 1024
 +
|}

Latest revision as of 18:55, 7 September 2020

There are similarities to presenting a (Creator) DLC and a mod. Although not all DLC techniques apply to mods, find details and configuration samples here.
A mod is generally a batch of files that constitute a consistent list of additions, but not limited to. A mod can have its very own presentation as shown. modPresentationMainMenu.jpg
Your mod is also present in the Expansions menu with a larger picture and a long description of its content or context, it is up to you. This also include a link to your website. modPresentationExpansionsMenu.jpg
Last but not least, you have the possibility to display an icon next to the content your mod adds or alters in Eden Editor interface.

In this screen, the kart object has the Karts DLC icon of the to which it belongs to.

modPresentationeditorList.jpg
In this screen though, a map has the DLC logo, but this time, Altis also has it because the mod uses or alters it. modPresentationMaps.jpg

A sample may be added in Arma 3 Tools, meanwhile, you can access the sources here, a demo here, and more information on DLC presentation here.


How to

file Mod.cpp

This is the definition file, it must be place in the root folder of your mod (Arma 3\Splendid Mod\mod.cpp) and can contain:

name		= "Splendid mod";								// Name of your mod
picture 	= "\Samples_F\Data_01\Images\picture.paa"; 		// Picture displayed from the expansions menu. Optimal size is 2048x1024
logoSmall	= "\Samples_F\Data_01\Logos\logo_small.paa";	// Display next to the item added by the mod
logo		= "\Samples_F\Data_01\Logos\logo.paa";			// Logo displayed in the main menu
logoOver	= "\Samples_F\Data_01\Logos\logoOver.paa";		// When the mouse is over, in the main menu
action		= "https://example.org/my-mod-page";			// Website URL, that can accessed from the expansions menu
tooltipOwned = "It's yours!";								// Tool tip displayed when the mouse is left over, in the main menu

// Color used for DLC stripes and backgrounds (RGBA)
dlcColor[] =
{
	0.23,
	0.39,
	0.30,
	1
};
// Overview text, displayed from the extension menu
overview = "Unleash your creativity! Here goes the long description of your mod.";
hideName	= 0;	// Hide the extension name
hidePicture	= 0;	// Hide the extension menu

Images

The images defined in the mod.cpp can be stored, either, individually in the mod directory or in a packed pbo.

In the case of non packed data, to keep your structure clear, it could be good to put your images in Arma 3\Splendid Mod\Data\, your mod.cpp has to be edited accordingly, for example, the logo will be defined as follow: Data\logo.paa. The same applies for every external references (in this case, image only).


If you opt for a packed data, you will have to put your images in a PBO and point the image path like in any other addon (the example of mod.cpp is based on packed file (PBO) which has for prefix "Samples_F").

Recommended sizes

Type A x B
Logo 128 x 128
LogoOver 128 x 128
LogoSmall 64 x 64
Picture 2048 x 1024