Difference between revisions of "Arma 3 Mod Presentation"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{tool-disclaimer| '''Work-In-Progress''' | Please, do not edit for now | bg = #F6D1C5 }} Category: Arma 3: Editing")
 
Line 4: Line 4:
 
| bg = #F6D1C5
 
| bg = #F6D1C5
 
}}
 
}}
 +
 +
 +
== Foreword ==
 +
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.
 +
 +
[[File:modPresentationExpansionsMenu.jpg|500px]]
 +
 +
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.
 +
 +
[[File:modPresentationeditorList.jpg|250px]] [[File:modPresentationMaps.jpg|250px]]
 +
 +
== 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 extansion 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 extansion menu}}
 +
overview = "Unleash your creativity! Here goes the long description of your mod.";
 +
{{codecomment|/// Hide the extansion name }}
 +
hideName = 0;
 +
{{codecomment|/// Hide the extansion menu}}
 +
hidePicture = 0;
 +
 +
=== Images ===
 +
==== In an addon ====
 +
==== Alternate method ====
 +
  
 
[[Category: Arma 3: Editing]]
 
[[Category: Arma 3: Editing]]

Revision as of 14:43, 9 April 2015

bohemia interactive logo black.png
'Work-In-Progress'
Please, do not edit for now


Foreword

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

modPresentationMainMenu.jpg

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.

modPresentationExpansionsMenu.jpg

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.

modPresentationeditorList.jpg modPresentationMaps.jpg

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 of your mod
name = "Splendid mod";
/// Picture displayed from the Expansions menu
picture = "\Samples_F\Data_01\Images\picture.paa";
/// Display next to the item added by the mod
logoSmall = "\Samples_F\Data_01\Logos\logo_small.paa";
/// Logo displayed in the main menu
logo = "\Samples_F\Data_01\Logos\logo.paa";
/// When the mouse is over, in the main menu
logoOver = "\Samples_F\Data_01\Logos\logoOver.paa";
/// Website URL, that can accessed from the extansion menu
action = "https://community.bistudio.com/wiki/Mod_Presentation";
/// Tool tip displayed when the mouse is left over, in the main menu
tooltipOwned = "It's yours!";
/// Color used for DLC stripes and backgrounds (RGBA)
dlcColor[] = 
{
	0.23,
	0.39,
	0.30,
	1
};
/// Overview text, displayed from the extansion menu
overview = "Unleash your creativity! Here goes the long description of your mod.";
/// Hide the extansion name 
hideName = 0;
/// Hide the extansion menu
hidePicture = 0;

Images

In an addon

Alternate method