Command reference

ItemGroup

ItemBuilder · builder

Command words: ig, itemgroup
Permission: Admin

Item Groups are used to group similar items when shown in a room, for example, when a venue has multiple tables that you don't want to show individually, or if you wanted to have lots of insignificant or small items grouped together to not drown out more important items.

This command is used to manage those item groups and set their parameters. To add these groups to item prototypes, see the ITEM command.

Item groups also have something called forms. Forms cause all the same item groups to appear differently in different contexts (usually different rooms), so you could have a grouping for tables and chairs which could be presented differently in different locations, such as different taverns or cafes.

The syntax for this command is as follows:

itemgroup add <name> - adds a new item group
itemgroup delete <which> - permanently deletes an item group
itemgroup show <which> - shows info about an item group
itemgroup list - lists all item groups **
itemgroup <which> name <name> - renames a group
itemgroup <which> keywords <space separated list> - sets the item group keywords
itemgroup <which> form add <type> - adds a new description form for a group
itemgroup <which> form delete <id> - deletes the specified form from a group
itemgroup <which> form <id> room <id> - toggles a room as using the form
itemgroup <which> form <id> ldesc <ldesc> - sets the long description of the form
itemgroup <which> form <id> name <item name> - sets the name of items in the form
itemgroup <which> form <id> desc - sets the look description for the form

** - The following options are available to filter the list:

+<keyword> - searches for a keyword in the item group or one of its forms
-<keyword> - excludes a keyword in the item group or one of its forms
*<room id> - searches for groups with forms that explicitly contain the specified room

← Back to Command reference