PBOPREFIX

From Bohemia Interactive Community
Revision as of 13:43, 11 January 2010 by WGL.Q (talk | contribs) (Added more content)
Jump to navigation Jump to search

$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