# Avatar Groups

Draft

The purpose of groups is to help you better organize your avatars and to help avatar creators to easily distribute them.

Groups have their own icon in the menu, and their own submenu containing its avatars.

For simplicity, groups are folders that contains avatars .yml files.

The folder must have a file called index.yml, this file contains information about the group, for example: name, icon, permission and priority (order) for displaying in the menu.

This file has a similar structure to invididual avatar configs, this is how an index.yml may look like:

index.yml
displayName: 'Halloween Pack'
permission: 'halloween'
order: 5

icon:
  title: "&6&oHalloween Avatars"
  description:
    - "&8&oI hope you don't get scared..."
  item:
    texture: "eyJ0Z ...(redacted big string)"

Here's what every option means:

Option	Type	Description
`order`	`int`	(Optional) Order/priority for the GUI, closer to 1 will attempt to appear first
`displayName`	`string`	The name of the group displayed in GUIs (eg. Selector Menu)
`permission`	`string`	Permission to use the group. This permission will have the prefix `logoutavatars.group.<perm>`
`icon`	`icon`	(Optional) Icon data, described in Avatar Config

plugins/LogoutAvatars/avatars/Halloween/
|-- LAHP_Broom.yml
|-- LAHP_Potion.yml
|-- LAHP_Pumpkin.yml
|-- LAHP_Witch.yml
`-- index.yml