Difference between revisions of "Arma 3 Mod Presentation"

From Bohemia Interactive Community
Jump to navigation Jump to search
(file Mod.cpp: fixed typo)
Line 30: Line 30:
 
  {{codecomment|/// When the mouse is over, in the main menu}}
 
  {{codecomment|/// When the mouse is over, in the main menu}}
 
  logoOver = "\Samples_F\Data_01\Logos\logoOver.paa";
 
  logoOver = "\Samples_F\Data_01\Logos\logoOver.paa";
  {{codecomment|/// Website URL, that can accessed from the extansion menu}}
+
  {{codecomment|/// Website URL, that can accessed from the expansion menu}}
 
  action = "https://community.bistudio.com/wiki/Mod_Presentation";
 
  action = "https://community.bistudio.com/wiki/Mod_Presentation";
 
  {{codecomment|/// Tool tip displayed when the mouse is left over, in the main menu}}
 
  {{codecomment|/// Tool tip displayed when the mouse is left over, in the main menu}}

Revision as of 15:38, 7 January 2016


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

A sample will be added soon in Arma 3 Tools, meanwhile, you can access the sources here and a demo 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 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 expansion 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

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