Config

This is the main configuration file for CatzFly. It controls the core mechanics of the plugin, such as economy, user interface, cooldowns, and world restrictions.

Economy

These settings control how paid flight works. Vault is required for these features to function.

Setting	Default	Description
enabled	true	If true, players can use in-game money to fly when their free flight time runs out. If false, flight is only possible with free time or bypass permissions.
cost-per-second	1.0	The amount of money deducted from a player's balance for each second of flight.
currency-symbol	$	The symbol used in messages and GUIs to represent your server's currency.

💡 Pro Tip: Using CatzFly Without an Economy

CatzFly is designed to be flexible and does not require an economy to function. If your server focuses on rewards and permissions rather than currency, you can easily disable the paid flight feature.

To do this, set the following in your config.yml:

economy:
  enabled: false

With this setting, flight will be powered exclusively by two methods:

• Consumable Items: Players can gain flight time by using items defined in items.yml.

• Admin Commands: Give players flight time with givetime and settime commands.

• Bypass Permission: Players with the catzfly.bypass permission will have unlimited flight.

This makes CatzFly a perfect fit for any setup where flight is a special reward, not a purchase.

Flight UI

This section configures the on-screen elements displayed to the player while flying.

Setting	Default	Description
action-bar.enabled	true	If true, flight status (time remaining, cost) will be shown on the player's action bar.
action-bar.update-interval	1	The update frequency in seconds for the action bar display. A value of 1 updates it every second.

Flight Warnings

Configure warnings that are sent to players when their flight time or money is about to run out.

Setting	Default	Description
low-balance-warning.enabled	true	If true, a warning is sent when a player's money balance can only sustain a limited amount of additional flight time.
low-balance-warning.seconds-threshold	180	The warning is triggered when the player's remaining balance is enough for less than this many seconds of flight.
free-flight-warning.enabled	true	If true, a warning is sent when a player's free flight time is about to expire.
free-flight-warning.seconds-threshold	10	The warning is triggered when the player has less than this many seconds of free flight time left.

Event Filter Cooldown

These settings manage the cooldown applied to a player after their flight is disabled by a rule in events.yml.

Setting	Default	Description
enabled	true	If true, a cooldown will be applied, preventing immediate re-activation of flight.
duration	10	The length of the flight cooldown in seconds.
show-action-bar	true	If true, the remaining cooldown time will be displayed on the player's action bar.

World Whitelist

Specify which worlds flight is allowed in.

Setting	Default	Description
world-whitelist	[] (empty)	A list of world names where players are allowed to fly. If this list is empty, flight is enabled in all worlds.

Example:

world-whitelist:
  - world
  - world_nether

Particle Effects

Global settings for the cosmetic flight particle system.

Setting	Default	Description
enabled	true	If true, players can use cosmetic flight particles.
spawn-interval-ticks	4	The interval in ticks (20 ticks = 1 second) at which particles are spawned for a flying player.
change-cooldown-seconds	3	The time in seconds a player must wait before they can change their active particle effect again.

To ensure a smooth experience, be mindful of your particle settings. Setting a high particle count combined with a low spawn-interval-ticks can negatively impact server performance (TPS), especially on servers with a large player base. We recommend using balanced values for optimal performance.