PBOPREFIX: Difference between revisions
mNo edit summary |
Killswitch (talk | contribs) mNo edit summary |
||
| Line 24: | Line 24: | ||
== Background == | == Background == | ||
Mod development happens on the '' | Mod development happens on the ''P: drive''.<br> | ||
It is good | 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 | |||
results in the namespace | results in the namespace | ||
| Line 41: | Line 41: | ||
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 | The following 3rd party tools will read and make use of a namespace definition in the $PBOPREFIX$ file, if it's present. | ||
* [http://dev-heaven.net/projects/list_files/mikero-pbodll MakePbo] | * [http://dev-heaven.net/projects/list_files/mikero-pbodll MakePbo] | ||
| Line 51: | Line 51: | ||
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 == | ||
Revision as of 13:28, 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 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's 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.