Quick start guide

Required Plugins

To use some features of the plugin, you'll need to install other plugins. If you don't have these plugins, the feature(s) won't be enabled.

A modern permissions plugin (such as LuckPerms) is required for:

Treasure Chests

Vault (with an economy plugin) or PlayerPoints is required for:

Money Loot from Treasure Chests.
The Ammo System.
The money option with Pet Renaming.

Lib's Disguises and consequently ProtocolLib are required for:

Morphs

Setup

After running UltraCosmetics for the first time, configuration files will be generated that you can edit. (Hint: when talking about configs, the key X.Y means the configuration option Y found in the section X.) Here are the most important settings to check out when installing the plugin:

First and most importantly, Treasure-Chests.Permission-Add-Command. (Ctrl+F for Permission-Add-Command if you can't find it.)

IF YOU USE LUCKPERMS: Permission-Add-Command should be set to '!lp-api' (and it must be in single quotes). This will use the LuckPerms API to add permissions. If you want to apply LuckPerms' contexts to the added permissions, simply add them after !lp-api, such as Permission-Add-Command: '!lp-api server=hub'. (You could still use the command option even if you're using LuckPerms, but using the API is faster and less spammy.)

IF YOU DO NOT USE LUCKPERMS: Permission-Add-Command must be set to whatever command you use for giving a permission to a specific player, where %name% is the username of the player and %permission% is the permission that should be added. Do not include the initial slash (/). A LuckPerms example is provided (although it's recommended to use the !lp-api option if you're actually using LuckPerms): Permission-Add-Command: lp user %name% permission set %permission% true
Treasure-Chests.Key-Price: how much it should cost to buy treasure chests through the GUI. Set to -1 to prevent purchasing, meaning they can only be obtained with /uc give key
Menu-Item.Enabled: Set this to true if you want players to receive an unmovable ender chest in their hotbar which they can use to equip gadgets. When this is not enabled, players can still use /uc menu main to open the menu, if they have permission.
Enabled-Worlds: a list of worlds where cosmetics (and the menu item) should be enabled. Defaults to * which is all worlds.

Testing

Now that you've configured the plugin (or at least started,) you can test it. (If anything doesn't work, jump down to the troubleshooting section.) The main thing to test is the treasure chests.

Set yourself to standard user permissions, because treasure chests will only give you money (and won't give you cosmetics) if you're opped or otherwise have all UC permissions.
Open the GUI with the menu item or /uc menu main and click the tripwire hook button at the top. This should let you buy keys.
After you've bought a key, click the chest button to open the treasure chest.
Once you've finished opening the loot chests, equip and use one of the cosmetics you got from the treasure chest (again, through the GUI or the menu command.)

Troubleshooting

Nothing happens when clicking the tripwire hook button

You need to install Vault + an economy plugin (such as Essentials) OR install PlayerPoints.

"Not enough room" when opening a treasure chest

Treasure chests require a certain amount of space for the chests and blocks to be placed. Move to an open area and try again.

Cosmetics given by the treasure chest still say "no permission"

Make sure you correctly set Permission-Add-Command for your permissions plugin. Permission commands run from the console, so check the console to see if there are any error messages from the command or anything else that could help you figure out the problem.