fs:addon_box
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
fs:addon_box [2020-01-06 22:16] skyjake [Box (add-on format)] |
fs:addon_box [2020-01-10 12:56] (current) skyjake [Example] |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| - | The **.box** format is a special [[addon format]], allowing several addons to be collected together. The box itself contains no data, only [[#Metadata|metadata]]. All data within the box is contained in separate [[#Components|components]]. | + | The **.box** format is a special [[modding:addon format]], allowing several addons to be collected together. The box itself contains no data, only [[#Metadata|metadata]]. All data within the box is contained in separate [[#Components|components]]. |
| This separation of metadata from addon-data provides several benefits: | This separation of metadata from addon-data provides several benefits: | ||
| Line 22: | Line 22: | ||
| - | The high-level structure of a //.box// is as follows: | + | The high-level structure of a **.box** is as follows: |
| | | ||
| collection.box / | collection.box / | ||
| Line 35: | Line 35: | ||
| - | <note>Unlike in [[bundle]]s, there is no //Contents/// folder. This is intended to highlight the fact that the box itself contains no data: it is merely a group of other addons.</note> | + | <note>Unlike in [[modding:addon bundle]]s, there is no **Contents/** subfolder. This is intended to highlight the fact that the box itself contains no data: it is merely a group of other addons.</note> |
| ==== Metadata ==== | ==== Metadata ==== | ||
| - | //[[info]]// is a plain **text file** (note the lack of extension in the name) which describes the contents of the box (known as metadata). (This is analogous to the use of //info// in [[addon_bundle]]s). | + | [[modding:Info]] is a plain text file — note the lack of extension in the name — which describes the contents of the box (i.e., metadata). This is analogous to the use of [[modding:Info]] in [[modding:addon bundle]]s. |
| ==== Components ==== | ==== Components ==== | ||
| - | A box may contain multiple sub-component addons. For example, a box might comprise two required [[pk3]]s, an optional [[ded]], and one [[wad]] file. The only restriction is that a box **cannot contain other boxes**. | + | A box may contain multiple sub-component addons. For example, a box might comprise two required [[PK3]]s, an optional [[DED]], and one [[WAD]] file. The only restriction is that a box cannot contain other boxes. |
| === Optional === | === Optional === | ||
| - | Addons in the root are optional. They will be **loaded by default** along with the box itself. | + | Addons in the root are optional. They will be loaded by default along with the box itself. |
| === Extra === | === Extra === | ||
| - | The //extra/// folder should contain addons that that are optional but which are **not active by default**. These components must be //activated// manually before use, for instance by checking on a checkbox in the Snowberry UI. | + | The **extra/** folder should contain addons that that are optional but which are //not// active by default. These components must be activated manually before use, for instance by checking on a checkbox in the GUI. |
| === Required === | === Required === | ||
| - | The //required/// folder should contain addons that are **always loaded** when the box itself is loaded. These components won't even be visible to the user. | + | The **required/** folder should contain addons that are //always// loaded when the box itself is loaded. These components won't even be visible to the user. |
| - | {{note|[[snowberry]] automatically categorizes all addons inside the box according to their type and/or contents and all are visible to the user (except those which are under [[#Required|Required]]) in the addon tree.}} | + | Snowberry automatically categorizes all addons inside the box according to their type and/or contents and all are visible to the user (except those which are under [[#Required|Required]]) in the addon tree. |
| Line 68: | Line 68: | ||
| - | First you'll need an [[info]] file which describes this collection of add-ons. Something like: | + | First you'll need an [[modding:Info]] file which describes this collection of add-ons. Something like: |
| | | ||
| name: Amaze-DOOM | name: Amaze-DOOM | ||
fs/addon_box.1578341791.txt.gz · Last modified: 2020-01-06 22:16 by skyjake
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
