-
Notifications
You must be signed in to change notification settings - Fork 46
infotxt
All packages must contain an info.txt
file located in the zip root. This defines what objects are present inside the package.
"ID" "BEE2_PACK_EXAMPLE"
"Name" "Example Package"
"Prerequisites"
{
"Package" "OTHER_PACKAGE_1"
"Package" "OTHER_PACKAGE_2"
}
"Item"
{ ... }
"Override"
{
"Item"
{ ... }
}
All packages must have a unique ID
to identify themseleves. The Name
should be a short human-readable string describing the package. This will be displayed in the Manage Packages window in the BEE2. If a package contains a Prerequisites
section, all the listed package IDs must be installed. If any are missing, the package will be ignored entirely. This makes it possible to refer to objects or resources in another package, without errors or missing content. As a special case, <MEL_MUSIC>
and <TAG_MUSIC>
cause a package to only be active if the music for the given game is found.
All other blocks define object types. These must also have an ID
to uniquely identify them, but vary in their other contents. If object definitions are placed in an "Overrides"
block, they are instead used to 'override' an existing item from another package. The ID should match another item (if no match is found, the definition is ignored). The configuration is merged with the original item config. This can be used to add additional styles to items for example, or otherwise extend objects.
The concept below is taken from the Half Grate item as an easy way to describe how info.txt files work:
"ID" "LAUTARO_HALF_GRATE"
// This ID can be anything, since it doesn´t affect the package´s function at all.
"Name" "Half Grate"
// If an item´s folder doesn´t have a property.txt file containing a description or a name, the Beemod palette will take the data from the info.txt file. But if properties.txt exists and contains Name / Description, it will override the data from info.txt.
"Desc" "Useful to walk a half block out"
// The same from above also goes for this patch.
"Item"
{
"ID" "ITEM_LAUTARO_HALF_GRATE"` // This ID needs to be the same from the editoritem file, located in the item´s folder.
"All_conf" "half_grate" // This patch is for a config file that will take effect in all of the styled versions of the Item.
"Version" // _This patch's function is unknown. If you know, please help the BEEMod community and add information!_
{
"Styles" // This patch meets the funtion of detecting the whole string of styled items from below.
{
"BEE2_CLEAN" "half_grate_clean" // <--- This patch tells Beemod which style is using your item. The folder´s name of the item, at the end of the name it must have the style´s name: "example_clean".
"BEE2_OVERGROWN" "half_grate_over" // "" ""
"BEE2_1950s" "half_grate_50s" // "" ""
"BEE2_1980s" "half_grate_80s" // "" ""
"BEE2_PORTAL_1" "half_grate_p1" // "" ""
}
} <---- These three closing brackets are required to split between other things such as new items additions on this file.
}