Config.cpp/bin File Format: Difference between revisions

Revision as of 19:02, 7 May 2025

Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.

Two mutually exclusive file formats exist for addons:

config.cpp (pre binarised, RaPifiable text) or
config.bin (binarised raP)

ⓘ

For a CPP file syntax, see CPP File Format - Syntax.

Rules of Engagement

By convention only:
- A 'bin' extension indicates binarised content.
- A 'cpp' extension indicates pre-binarised text.
A cpp can, as equally, contain binarised content. No harm is done, and, indeed, this is familiar territory to rvmat files where there is no distinction. An rvmat (e.g) contains either format.
If both file formats exist in a PBO directory (e.g config.bin and config.cpp, the .bin is ignored.

Usage

Most pbos contain binarised configs (config.bin). This is because it saves engine loading time and guarantees the config.cpp it came from was syntactically correct (no missing semicolons, duplicate or missing classes, etc). There is almost no circumstance where a config.cpp should be released in a finished product. There are exceptions from very sophisticated, veteran, addon makers.
Some pbos contain cpp because:
- It is a work-in-progress.
- they rely on #includes and/or
- they use __EVAL/__EXEC statements, or
- the author does not know how to binarise or
- binarisation fails.

There is no binarised equivalent for exec/eval or include.

Exec/Eval

ⓘ

See PreProcessor Commands - Config Parser.

Although unusual, __EVAL and __EXEC are the only method of compiling dynamic variables during run time. They are exclusively useful in Description.ext and its derivative script dialogs. Although it can be, that specific file is never pre-binarised and is compiled on each mission load.

Some very few dialog addons also use this method in their config.cpp's, BUT, in this circumstance, they offer no additional benefit to using #defines. This is because an addon is loaded and compiled only once.

Includes

Includes, while unusual, are a method of pre-configuring a series of PBOs for run time. There are many themes, but the main thrust is a common, text-based PBO, containing #defines. This is accessed from a series of dependent pbo's. In this manner, you can alter and update a common pbo and all the children don't require updating. ace_x and cba are popular architects of this scheme.

For these architectures to work, they require config.cpp's since there is no equivalent in raP binary for #include or __EVAL.

Many configs, same PBO

Any mission makers familiar with campaign architecture implicitly understand that this is simply packaging multiple addons inside a single one.

Any folder within the pbo containing a config.cpp/bin (and cfgpatches class) is automatically an addon in it is own right.

@@ Line 7: / Line 7: @@
 * '''config.cpp''' (pre binarised, RaPifiable text) '''or'''
 * '''config.bin''' (binarised raP)
+<!--
-''Both'' can co-exist in a pbo without harm. (the bin is ignored)
+{{Feature|informative|An addon is a PBO, but a PBO is not necessarily an addon. Mission PBOs do '''not''' contain addon configs while mission addons do.}}
+-->
-'''Note:'''
+{{Feature|informative|For a CPP file syntax, see {{Link|CPP File Format#Syntax}}.}}
-An 'addon' is a 'pbo'. ''But'', a pbo is not necessarily an addon. Mission pbo's do '''not''' contain configs. Mission ''Addons'' do.
 == Rules of Engagement ==
-* '''By convention only'''
+* '''By convention only:'''
 ** A 'bin' extension '''indicates''' ''binarised'' content.
 ** A 'cpp' extension '''indicates''' ''pre-binarised'' text.
@@ Line 26: / Line 24: @@
 == Usage ==
-*''Most'' pbos contain binarised configs (config.bin). This is because it saves engine loading time '''and''' guarantees the {{hl|config.cpp}} it came from was syntactically correct (no missing semicolons, duplicate or missing classes, etc). There is almost no circumstance where a {{hl|config.cpp}} should be released in a finished product. There are exceptions from '''very''' sophisticated, veteran, addon makers. Their [[Scripting Tags|OFPEC tag]] names say it all, not their {{hl|cpp}}s.
+*''Most'' pbos contain binarised configs (config.bin). This is because it saves engine loading time '''and''' guarantees the {{hl|config.cpp}} it came from was syntactically correct (no missing semicolons, duplicate or missing classes, etc). There is almost no circumstance where a {{hl|config.cpp}} should be released in a finished product. There are exceptions from '''very''' sophisticated, veteran, addon makers.
 *''Some'' pbos contain cpp because:
 ** It is a work-in-progress.
@@ Line 39: / Line 37: @@
 === Exec/Eval ===
-Although unusual, EVAL and EXEC are the only method of compiling dynamic variables '''during''' run time. They are '''exclusively''' useful in description.ext and it is derivative script dialogs. Although it can be, that specific file, is never pre-binarised. It is compiled on each mission load.
+{{Feature|informative|See {{Link|PreProcessor Commands#Config Parser}}.}}
-Some, very few, dialog addons also use this method in their config.cpp's, BUT, in this circumstance, they offer no additional benefit to using #defines. This because an addon is loaded and compiled, once. Bis have attempted to develop ''dynamic addons'' and stopped. Should they resurrect it '''....'''
-Note that there is deeper level of sophistication here that an _EVAL used in a #include in a config.cpp, could *separately* be used in sqf/sqs script. But, there simply isn't a reason for the config.cpp to be unbinarised at this moment (see above dynamic addons).
+Although unusual, __EVAL and __EXEC are the only method of compiling dynamic variables during run time.
+They are '''exclusively''' useful in [[Description.ext]] and its derivative script dialogs.
+Although it can be, that specific file is never pre-binarised and is compiled on each mission load.
-See also: [[PreProcessor Commands]]
+Some very few dialog addons also use this method in their config.cpp's, BUT, in this circumstance, they offer no additional benefit to using #defines.
+This is because an addon is loaded and compiled only once.
 === Includes ===
-Includes, while unusual, are a method of pre-configuring '''a series of pbo's''' for run time.
+Includes, while unusual, are a method of pre-configuring a series of PBOs for run time.
-There are many themes, but the main thrust is a common, text-based pbo, containing #defines. This is accessed from a series of dependent pbo's.
+There are many themes, but the main thrust is a common, text-based PBO, containing #defines. This is accessed from a series of dependent pbo's.
 In this manner, you can alter and update a common pbo and all the children don't require updating. ace_x and cba are popular architects of this scheme.
-For these architectures to work, they require config.cpp's since there is no equivalent in raP binary for #include or __EVAL
+For these architectures to work, they require config.cpp's since there is no equivalent in raP binary for #include or __EVAL.
-== Many configs, same pbo ==
+== Many configs, same PBO ==
-Any mission makers familiar with campaign architecture implicitly 'understand' that this is simply packaging multiple addons inside a single one.
+Any mission makers familiar with campaign architecture implicitly understand that this is simply packaging multiple addons inside a single one.
 Any folder within the pbo containing a config.cpp/bin (and cfgpatches class) is automatically an addon in it is own right.