-
Notifications
You must be signed in to change notification settings - Fork 46
Package Basics Adding Your First Item
Your folder should resemble something around the lines of this:
Package Name
│ info.txt
│
├───items
│ └───your_item
│ editoritems.txt
│ properties.txt
│ vbsp_config.cfg
│
└───resources
├───BEE2
│ └───items
│ └───clean
│ your_item.png //this is the item icon displayed in the bee gui
│
├───instances
│ └───clean
│ └───items
│ └───your_item
│ your_item.vmf //this is what is added into the level wherever you place your item
│
├───materials
│ ├───BEE2
│ │ └───models
│ │ └───props_map_editor
│ │ └───your_item
│ │ your_item.vmt //this is the texture used by the in-game editor
│ │
│ └───models
│ └───props_map_editor
│ └───palette
│ └───bee2
│ your_item.vtf //this is the palette icon in the in-game editor
│
└───models
├───props_map_editor
│ your_item.dx90.vtx //these files are the model that is displayed in the editor
│ your_item.mdl
│ your_item.vvd
│
└───puzzlemaker
selection_your_item.3ds //this file determines where the editor considers the model to be
info.txt is what tells bee what your package contains and where to find its contents. This file should be at the root of every package.
editoritems.txt defines how your item will behave in the in-game editor as well as how it will turn out when in an actual map.
properties.txt is a small file that gives bee a little more information about your item. The info put here will be displayed in the bee gui when your item is clicked on.
vbsp_config.cfg lets bee give your item more flexibility by allowing you to change how your item will behave in levels. This allows for things such as rotation-based variants, random variants, and different items for different portalability.
More information can be found here
To start off your info.txt, you are going to want to define the id, name, and description of your package.
Example:
"ID" "MY_PKG"
"Name" "My Package"
"Desc" "An example package."
After these lines, you will want to add a list of your items, styles, music, and more. (see next section)
For your item to be included in BEE, you will have to add it to the info.txt file.
Usually, items will follow the pattern of
"Item"
{
"ID" "MY_PKG_COOL_ITEM"
"Version"
{
"Styles"
{
"BEE2_CLEAN" "my_folder" // this is referencing the item folder inside the `items` folder of your package
}
}
}
info on items in info.txt can also be found here
Section by Baguettery, this has not been reviewed.
The properties.txt file will usually consist of something like this:
"Properties"
{
"Authors" "My Name" //authors can be separated by any of **,** , **;** , or **/**
"Description" "This is my cool item, and the text describing what it does."
"Icon" "clean/my_icon.png" //this refers to the png image located relative to *resources/BEE2/*
{
"all" "icon_all.png" //the png variant of all_icon
"0" "icon.png" //there should be an icon for every variant of your item
}
}
Here is a list of the flags and what they do:
Index: tags, authors, ent_count, infoURL, all_name, all_icon
Defines what attributes your item can be filtered by in BEE.
This can be separated by ,, ;, or /
Usage:
"Properties"
{
"Tags" "MyTag,OtherTag"
}
Sets the authors displayed in BEE.
This can be separated by ,, ;, or /
Usage:
"Properties"
{
"Authors" "MyName,OtherName"
}
Allows to link to a webpage to show any additional information on your item.
Usage:
"Properties"
{
"infoURL" "myURL"
}
This determines the name of your item when dragged into the palette if it has multiple variants.
Usage:
"Properties"
{
"all_name" "my generic item"
}
This determines the icon of your item in the editor if your item has multiple subtypes. This should be a VTF.
Usage:
"Properties"
{
"all_icon" "my generic icon"
}
Not done yet
Not done yet
Not done yet
Not done yet
Not done yet
Not done yet