This page contains an annotated version of the
config.yml file that should show how you can configure HuskTowns.
# ------------------------------ # | HuskTowns Config | # | Developed by William278 | # ------------------------------ # Configuration guide: https://github.com/WiIIiam278/HuskTownsDocs/wiki/Config-File language: 'en-gb' # Language file to use data_storage_options: storage_type: 'SQLite' # Database type (SQLite or mySQL; latter is required for Bungee features) mysql_credentials: # If you are using mySQL, enter the credentials below host: 'localhost' port: 3306 database: 'HuskTowns' username: 'root' password: 'pa55w0rd' params: '?autoReconnect=true&useSSL=false' connection_pool_options: # Hikari connection pooling SQL parameters; don't change unless you know what you're doing! maximum_pool_size: 10 minimum_idle: 10 maximum_lifetime: 1800000 keepalive_time: 0 connection_timeout: 5000 table_names: # Names for the tables on the database. Don't change unless you know what you are doing player_table: 'husktowns_players' towns_table: 'husktowns_towns' claims_table: 'husktowns_claims' locations_table: 'husktowns_locations' bonuses_table: 'husktowns_bonus' bungee_options: enable_bungee_mode: false # Whether to enable bungee compatibility if you are using the plugin on multiple servers on a proxied network server_id: 'server' # The ID of this server on the bungee network (e.g if the server is "/server survival1" put "survival1" here. cluster_id: 0 # The ID of the cluster of servers if you are using multiple-clusters of HuskTowns servers on the network. Don't change unless you know what you are doing! general_options: enable_town_chat: true # Allow /townchat <message> ? toggelable_town_chat: true # Allow players to toggle /townchat with the command? (Might not work with some Bungee-chat plugins as that overrides the chat event) invite_expiry: 120 # How many seconds after a town invite is sent should it expire? teleport_warmup_secs: 5 # How long it takes to warm up a teleport to town spawn (If you are using HuskHomes integration, this and the other teleport settings is set in the HuskHomes config.yml instead) teleport_warmup_sound: BLOCK_NOTE_BLOCK_BANJO # Sound that is made during countdown teleport_complete_sound: ENTITY_ENDERMAN_TELEPORT # Sound that is made when teleporting teleport_cancel_sound: ENTITY_ITEM_BREAK # Sound that is made when teleporting is cancelled claim_inspection_tool: 'stick' # The inspection item you can use to inspect claims in the world by right clicking town_map_square_radius: 5 # How big the claim /map is admin_town_name: 'Administrators' # Name of the admin town (what admin claims are claimed by) admin_town_color: '#ff7e5e' # Color of the admin town allow_public_access_to_farm_chunks: false # Allow non-town members to build in farm chunks? set_town_spawn_in_first_claim: true # When players create their first town claim, should the town spawn be automatically set in it? allow_killing_hostiles_everywhere: true # Override claim permissions for players to let them kill hostile monsters anywhere block_pvp_friendly_fire: true # Whether or not to block friendly fire between town members prohibited_town_names: # List of strings town names cannot contain - admin unclaimable_worlds: # List of worlds that claims cannot be made in - world_nether - world_the_end help_menu: hide_commands_without_permission: true # Whether to hide commands on /husktowns help that users don't have permission for hide_husktowns_command: false # Whether to hide the /husktowns command from the /husktowns help menu use_database_fallback_on_cache_fail: false # Whether to fallback on the database if caches fail. Not recommended unless you are experiencing cache synchronisation issues. Contact us for support first! flag_options: # Set the default flags for within towns as well as the flag settings for wilderness and unclaimable worlds default_town_flags: regular_chunks: explosion_damage: false fire_damage: false mob_griefing: false monster_spawning: true pvp: false public_build_access: false public_container_access: false public_interact_access: false farm_chunks: explosion_damage: true fire_damage: false mob_griefing: false monster_spawning: true pvp: false public_build_access: false public_container_access: false public_interact_access: false plot_chunks: explosion_damage: false fire_damage: false mob_griefing: false monster_spawning: true pvp: false public_build_access: false public_container_access: false public_interact_access: false wilderness_flags: explosion_damage: true fire_damage: true mob_griefing: true monster_spawning: true pvp: false public_build_access: true public_container_access: true public_interact_access: true unclaimable_world_flags: explosion_damage: true fire_damage: true mob_griefing: true monster_spawning: true pvp: true public_build_access: true public_container_access: true public_interact_access: true admin_claim_flags: explosion_damage: false fire_damage: false mob_griefing: false monster_spawning: false pvp: false public_build_access: false public_container_access: false public_interact_access: true integrations: economy: enabled: true # Whether to enable economy features? (Needed for town levelling and depositing in the coffers) town_creation_cost: 150.0 # Cost to create a new town welcome_message_cost: 0.0 # Cost to change the town welcome message farewell_message_cost: 0.0 # Cost to change the town farewell message town_set_spawn_cost: 50.0 # Cost to change the location of the town spawn town_rename_cost: 100.0 # Cost to rename the town deposit_notification_threshold: 0.01 # 0-1; Percentage of the town's wealth of a deposit required for a notification to be broadcast to all town members. (higher numbers mean that people depositing into the coffers won't announce unless they deposit a lot of money at once) huskhomes: enabled: true # Enable integrating with HuskHomes for teleporting? block_sethome_in_other_towns: true # Whether to block setting HuskHomes homes in other towns map: enabled: false # Whether or not to enable the map integration plugin: 'dynmap' # The map plugin to use (dynmap, bluemap, pl3xmap) marker_set_name: 'Towns' # The name of the marker set use_town_colors: true # Whether to use the color of towns on the map default_town_color: '#4af7c9' # The color that will represent a town otherwise claim_fill_opacity: 0.5 # The opacity of claims on the map claim_stroke_opacity: 0 # The stroke opacity of claims on the map claim_stroke_weight: 1 # The stroke weight of claims on the map town_levelling: level_deposit_requirements: # Coffer deposit requirements to reach each level - 0.0 # Level 1 - 500.0 # Level 2 - 2500.0 # Level 3 - 5000.0 # Level 4 - 10000.0 # Level 5... etc - 15000.0 - 30000.0 - 50000.0 - 75000.0 - 100000.0 - 200000.0 - 300000.0 - 400000.0 - 500000.0 - 750000.0 - 1000000.0 - 2500000.0 - 5000000.0 - 10000000.0 - 50000000.0 level_max_claims: # Maximum claims towns can make at each level. - 10 # Level 1 - 15 # Level 2 - 20 # Level 3 - 25 # Level 4 - 50 # Level 5... etc - 60 - 75 - 80 - 80 - 100 - 125 - 150 - 175 - 200 - 250 - 300 - 400 - 500 - 600 - 700 level_max_members: # Maximum members towns can have at each level. - 8 # Level 1 - 10 # Level 2 - 15 # Level 3 - 20 # Level 4 - 25 # Level 5... etc - 30 - 30 - 30 - 30 - 50 - 50 - 50 - 50 - 50 - 75 - 75 - 75 - 100 - 100 - 100 config_file_version: '1.0' # Internal value, do NOT change!!