config.yml Configuration

The config.yml file is the heart of the ECosmetics plugin. Here you can configure everything from the database connection to the mechanics of cosmetics and integrations with other plugins.

Main Settings

These parameters define the key behavior of the plugin.

Parameter	Type	Description
permissions	true/false	A very important parameter. Determines how players receive cosmetics. false (default): cosmetics are stored in the database and must be given via commands. true: cosmetics are granted via permissions, for example, through LuckPerms.
debug	true/false	Enables debug mode. Additional information about the plugin's operation will appear in the console. Useful for finding errors.
show-all-cosmetics-in-menu	true/false	If true, the menu will display all existing cosmetic items, even those unavailable to the player. Unavailable items will look different. If false, the player will only see the cosmetics they own.
main-menu	string	The ID of the menu from the menus.yml file that will be opened with the /ecosmetics command. Default: hat.

Attention!

Changing the permissions parameter from false to true (or vice versa) on a live server may cause players to lose access to their cosmetics. Choose the operating mode in advance.

Database

These settings are responsible for storing player data.

Parameter	Type	Description
MySQL.enabled	true/false	If true, the plugin will use MySQL. If false (default), the local SQLite database (cosmetics.db) will be used.
MySQL.host	string	The IP address or domain of your MySQL server.
MySQL.port	number	The port of your MySQL server (default is 3306).
MySQL.user	string	The username for connecting to the database.
MySQL.password	string	The user's password for connecting to the database.
MySQL.database	string	The name of the database the plugin will use.
MySQL.table	string	The name of the table for storing data. Default: player_cosmetics.
MySQL.options	string	Additional connection parameters for MySQL (e.g., useSSL=false).

Wardrobe Zone

Settings related to the interactive zone for trying on cosmetics.

Parameter	Type	Description
leave-wardrobe-gamemode	string	The game mode that will be set for the player after leaving the wardrobe zone. Possible values: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR. If not specified, the original mode will be restored.
zones-hide-items	true/false	If true, the player's inventory will be temporarily cleared upon entering the zone and restored upon leaving.
zones-actions	true/false	If true, commands from zones.yml will be executed upon entering (on_enter) and leaving (on_exit) the zone.
bossbar-color	string	The color of the boss bar displayed in the zone. Possible values: PINK, BLUE, RED, GREEN, YELLOW, PURPLE, WHITE.

Cosmetic Settings

These parameters affect the operation of specific types of cosmetics.

Parameter	Type	Description
spray-key	string	The key combination for using a spray. Possible values: SHIFT_F, SHIFT_E, SHIFT_Q, SHIFT_LC, SHIFT_RC, SHIFT_JUMP, API.
spray-stay-time	number	The time in seconds that the spray will be visible on a surface.
spray-cooldown	number	The time in seconds a player must wait before using a spray again.
balloons-rotation	number (float)	The rotation speed of balloons.
worlds-blacklist	list of strings	A list of worlds where cosmetics will be automatically hidden and plugin commands will be disabled.

Integrations

Settings for interacting with other plugins.

Parameter	Type	Description
placeholder-api	true/false	Enables PlaceholderAPI support. Requires a server restart (not a plugin reload) to register.
luckperms-server	string	Used for LuckPerms if you want cosmetic permissions to be granted only on a specific server (context). Leave empty if not needed.

Other Settings

Parameter	Type	Description
proxy	true/false	Enable if your server is running on a BungeeCord or Velocity network for correct data synchronization.
equip-message	true/false	If true, a message will be sent to the player in chat when equipping a cosmetic.
save-data-delay	number	The interval in seconds at which player data is saved to the database.
on_execute_cosmetics	string	The command that will be executed on behalf of the player when they open the menu (/ecosmetics).