PBOPREFIX: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<tt>([^= ]+)<\/tt>" to "{{hl|$1}}")
 
(11 intermediate revisions by 7 users not shown)
Line 6: Line 6:


It has no file extension.  
It has no file extension.  
When using Mikero's Tools to pack PBOs you can use a file called pboprefix.txt, making it easier to edit.
PBO Manager require to use {{hl|$prefix$}} filename instead.


== File format ==
== File format ==
Line 24: Line 28:
== Background ==
== Background ==


Mod development happens on the ''p drive''.<br>
Mod development happens on the ''P: drive''.<br>
It is good design to use your own namespace, aka subfolder, for your development work.<br>
It is good practice 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 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.
The folder structure you define translates into the namespace.


  p:\myMod\myAddon
  P:\myMod\myAddon


results in the namespace
results in the namespace
Line 41: Line 45:
BinBPO requires a two layer subfolder structure to work.<br>
BinBPO requires a two layer subfolder structure to work.<br>


The following 3rd party tools allow and require a namespace definition in the $PBOPREFIX$ file.
The following 3rd party tools will read and make use of a namespace definition in the $PBOPREFIX$ file, if it is present.
 
* [http://dev-heaven.net/projects/list_files/mikero-pbodll MakePbo]
* [http://dev-heaven.net/projects/list_files/mikero-pbodll Eliteness]
* [http://www.kegetys.net/arma cpbo]


* [[Mikero_Tools|MakePbo (Mikero's Tools)]]
* [[Mikero_Tools|Eliteness (Mikero's Tools)]]
* <nowiki>http://www.kegetys.net/arma</nowiki> cpbo //-- dead link


== Benefits ==
== Benefits ==


You can name your PBO file anyway you like it, like adding a version tag. <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.
At the same time the internal path structure remains the same as defined by the $PBOPREFIX$ file.


== Further reading ==
== Further reading ==
Line 58: Line 61:
* [[CMA:DevelopmentSetup|Development Setup]]
* [[CMA:DevelopmentSetup|Development Setup]]


[[category:ArmA:_Addon_Configuration]]
{{GameCategory|arma1|Addon_Configuration}}

Latest revision as of 01:16, 16 November 2021

$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.

When using Mikero's Tools to pack PBOs you can use a file called pboprefix.txt, making it easier to edit.

PBO Manager require to use $prefix$ filename instead.

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 practice 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


The namespace is saved as part of the PBO file itself.
BinPBO does not expose the namespace. It is set in the app settings.
BinBPO requires a two layer subfolder structure to work.

The following 3rd party tools will read and make use of a namespace definition in the $PBOPREFIX$ file, if it is present.

Benefits

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