Config.yml

=== 🛡️ Configuration (config.yml) 🛡️ ===

This file is the central control panel for Anarchy Stabilizer, allowing you to tailor its behavior precisely to your server's needs.

Location: You can find this file at plugins/AnarchyStabilizer/config.yml after running the plugin for the first time.

Editing & Reloading: Edit this file using any standard text editor. To apply changes, you can either restart your server or use the in-game command /as reload (requires the permission anarchystabilizer.command.reload).

Section: features

This section acts as the master switch for each major component (module) of the plugin. If you don't need a particular feature, you can disable it here entirely without needing to configure its specific section.

  • redstone_control: <true|false>

    • Purpose: Enables or disables all Redstone Control functionality.

    • Values: true (enabled), false (disabled).

    • Default: true

    • Effect: If false, the entire redstone_control section below is ignored.

  • armor_stand_control: <true|false>

    • Purpose: Enables or disables all Armor Stand Control functionality.

    • Values: true (enabled), false (disabled).

    • Default: true

    • Effect: If false, the entire armor_stand_control section below is ignored.

  • item_cleanup: <true|false>

    • Purpose: Enables or disables the periodic Ground Item Cleanup functionality.

    • Values: true (enabled), false (disabled).

    • Default: true

    • Effect: If false, the entire item_cleanup section below is ignored.

  • vehicle_control: <true|false>

    • Purpose: Enables or disables all Vehicle Control functionality (Minecarts, Boats).

    • Values: true (enabled), false (disabled).

    • Default: true

    • Effect: If false, the entire vehicle_control section below is ignored.

Section: redstone_control

(This section is only active if features.redstone_control is set to true)

This module aims to mitigate lag caused by complex or abusive redstone contraptions.

  • mode: <'off'|'disable_all'|'disable_list'>

    • Purpose: Determines the method used to control redstone activity.

    • Values:

      • 'off': No redstone control is applied by this plugin module.

      • 'disable_all': Attempts to block all redstone updates and mechanism activations detected by the plugin. This is a very aggressive setting and might impact legitimate builds; use with caution and testing.

      • 'disable_list': Only disables the specific block types defined in the disabled_mechanisms list below. This is the recommended mode for targeted control.

    • Default: 'disable_list'

  • disabled_mechanisms: [List of Material Names]

    • Purpose: Defines the specific block types that will be disabled when mode is set to 'disable_list'.

    • Format: A YAML list of strings. Each string must be a valid Bukkit Material name (case-insensitive matching is attempted, but using uppercase is recommended). You can find official Material names here.

    • Functionality: The plugin listens for events associated with these blocks (e.g., piston extending, dispenser firing) and cancels the event if the block type is in this list.

    • Default: ['PISTON', 'STICKY_PISTON', 'OBSERVER', 'DISPENSER', 'DROPPER'] (Common components found in lag machines).

Section: armor_stand_control

(This section is only active if features.armor_stand_control is set to true)

This module manages armor stands to prevent excessive accumulation or potential exploits.

  • mode: <'off'|'prevent_placement'|'remove_on_placement'|'remove_all_periodically'>

    • Purpose: Selects how armor stand placement and existence are handled.

    • Values:

      • 'off': No control applied. Armor stands function normally.

      • 'prevent_placement': Actively cancels the event when a player tries to place an armor stand item. No new armor stands can be placed.

      • 'remove_on_placement': Also cancels the placement event in the current implementation, effectively achieving the same result as prevent_placement.

      • 'remove_all_periodically': Activates a periodic task that removes all loaded armor stands across the server. Warning: This is highly destructive and will remove decorative or functional armor stands used by players. Use only if absolutely necessary and be aware of the consequences. Requires configuration in the periodic_removal subsection below.

    • Default: 'prevent_placement'

  • Subsection: periodic_removal (These settings are only used if armor_stand_control.mode is set to 'remove_all_periodically')

    • interval_seconds: <number>

      • Purpose: Sets the time, in seconds, between each server-wide armor stand removal cycle.

      • Default: 600 (10 minutes)

    • warn_before_removal: <true|false>

      • Purpose: If set to true, a warning message will be broadcast to all players before each removal cycle.

      • Default: true

    • warning_time_seconds: <number>

      • Purpose: If warn_before_removal is true, this specifies how many seconds before the removal the warning message is sent. Must be less than interval_seconds.

      • Default: 30

    • warning_message: "<message>"

      • Purpose: The message format broadcast before removal.

      • Formatting: Supports standard Bukkit color codes using &.

      • Placeholders: {time} will be replaced with the value of warning_time_seconds.

      • Default: "&cWarning! All Armor Stands will be removed in {time} seconds!"

    • removal_message: "<message>"

      • Purpose: The message format broadcast after the removal is complete.

      • Formatting: Supports standard Bukkit color codes using &.

      • Placeholders: {count} might be added in the future.

      • Default: "&aAll existing Armor Stands have been removed."

Section: item_cleanup

(This section is only active if features.item_cleanup is set to true)

This module helps reduce entity lag by periodically removing dropped items from the ground.

  • interval_seconds: <number>

    • Purpose: Sets the time, in seconds, between each item cleanup cycle.

    • Default: 300 (5 minutes)

  • warning_times_seconds: [List of Numbers]

    • Purpose: A list defining when warning messages should be broadcast before the cleanup happens. Each number represents seconds remaining until cleanup.

    • Example: [60, 30, 10] means warnings will be sent at 60 seconds, 30 seconds, and 10 seconds before items are removed.

    • Default: [60, 30, 10]

  • warning_message: "<message>"

    • Purpose: The message format broadcast at the times specified in warning_times_seconds.

    • Formatting: Supports standard Bukkit color codes using &.

    • Placeholders: {time} will be replaced with the specific number of seconds remaining (e.g., 60, 30, or 10 in the default case).

    • Default: "&eWarning: Ground items will be cleared in {time} seconds!"

  • cleanup_message: "<message>"

    • Purpose: The message format broadcast after items have been removed.

    • Formatting: Supports standard Bukkit color codes using &.

    • Placeholders: {count} might be added in the future.

    • Default: "&aGround items cleared."

Section: vehicle_control

(This section is only active if features.vehicle_control is set to true)

This module aims to prevent lag caused by excessive accumulation of vehicles (Minecarts and Boats).

  • mode: <'off'|'limit_per_chunk'|'prevent_placement'>

    • Purpose: Selects the method used to control vehicles.

    • Values:

      • 'off': No vehicle control applied.

      • 'limit_per_chunk': Activates a periodic task that checks loaded chunks and removes excess vehicles based on the limits defined below. (Recommended)

      • 'prevent_placement': Prevents players from placing new Minecart or Boat items into the world. Can be restrictive for normal gameplay.

    • Default: 'limit_per_chunk'

  • Subsection: limit_settings (These settings are only used if vehicle_control.mode is set to 'limit_per_chunk')

    • check_interval_seconds: <number>

      • Purpose: Sets how often, in seconds, the plugin checks loaded chunks for excess vehicles. Setting this too low (e.g., below 10-15s) might have a minor performance impact on very large servers.

      • Default: 20

    • minecart_limit_per_chunk: <number>

      • Purpose: Defines the maximum number of all types of Minecarts allowed to exist within a single chunk (16x16 area). If the check finds more than this number in a chunk, the excess ones will be removed.

      • Default: 25

    • boat_limit_per_chunk: <number>

      • Purpose: Defines the maximum number of all types of Boats allowed to exist within a single chunk. If the check finds more than this number, the excess ones will be removed.

      • Default: 15

    • log_removals: <true|false>

      • Purpose: If true, a message summarizing the number of removed Minecarts and Boats will be printed to the server console after each check cycle where removals occurred. Useful for monitoring.

      • Default: true

This detailed explanation should cover all the configuration options currently available in Anarchy Stabilizer. Remember to use /as reload after saving changes to this file!

PreviousAnarchyStabilizerNextCommands and permissions

Last updated