PBOPREFIX: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(new topic to allow more verified details to complete this)
 
(Added more content)
Line 1: Line 1:
=$PBOPREFIX$=
= $PBOPREFIX$ =
$PBOPREFIX$ is the name of a text file that sits in the root folder of an addon. (i.e. ".\myAddon\$PBOPREFIX$"). It has no file extension.


==File format==
$PBOPREFIX$ is the name of a text file that sits in the root folder of an addon.
* The file contents contains a folder path name and/or addon name (Exact format needs verifying)
 
* It only contains one line
.\myAddon\$PBOPREFIX$
* There is no new line at the end of line one (at least not in earlier versions)
 
* There is no whitespace before or after the text
It has no file extension.
 
== File format ==
 
The file contains only a namespace definition. A namespace is practically a path definition.


'''Examples:'''
'''Examples:'''
Line 15: Line 18:
  x\myMod\addons\myAddon
  x\myMod\addons\myAddon


==Effects and Benefits==
* It only contains one line.
* Totally Unknown - (please advise)
* There is no new line at the end of line one.
* There is no whitespace before or after the text.
 
== Background ==
 
Mod development happens on the ''p drive''.<br>
It is good design to use your own namespace, aka subfolder, for your development work.<br>
The main reason is to keep your workspace clean and to avoid conflicts with other addons.<br>
 
The folder structure you define translates into the namespace.
 
p:\myMod\myAddon
 
results in the namespace
 
myMod\myAddon
 
== Benefits ==
 
It is a requirement to have [[BinPBO]] work. BinBPO requires a two layer subfolder structure to work. <br>
 
You can name your PBO file anyway you like it, like adding a version tag. <br>
At the same time the internal path structure remains the same as defined by the PBOPREFIX file.
 
== Further reading ==
 
* [[ArmA Build Environment Setup]]
* [[CMA:DevelopmentSetup|Development Setup]]


[[category:ArmA:_Addon_Configuration]]
[[category:ArmA:_Addon_Configuration]]

Revision as of 12:43, 11 January 2010

$PBOPREFIX$

$PBOPREFIX$ is the name of a text file that sits in the root folder of an addon.

.\myAddon\$PBOPREFIX$

It has no file extension.

File format

The file contains only a namespace definition. A namespace is practically a path definition.

Examples:

myAddon
myMod\myAddon
x\myMod\addons\myAddon
  • It only contains one line.
  • There is no new line at the end of line one.
  • There is no whitespace before or after the text.

Background

Mod development happens on the p drive.
It is good design to use your own namespace, aka subfolder, for your development work.
The main reason is to keep your workspace clean and to avoid conflicts with other addons.

The folder structure you define translates into the namespace.

p:\myMod\myAddon

results in the namespace

myMod\myAddon

Benefits

It is a requirement to have BinPBO work. BinBPO requires a two layer subfolder structure to work.

You can name your PBO file anyway you like it, like adding a version tag.
At the same time the internal path structure remains the same as defined by the PBOPREFIX file.

Further reading