Skip to content

Configuration

Bartłomiej Stępień edited this page Apr 11, 2024 · 27 revisions

Configuration

Main config file will be generated after server start. Ths file contains all configs which are used by Eagle Factions. You can change them as you need.

NOTE: If future updates will add more config nodes to this file, you will need to delete this file and regenerate it!

Config file actual for 1.0.0

###########################################################################
##                                                                       ##
##    ______            _        ______         _   _                    ##
##   |  ____|          | |      |  ____|       | | (_)                   ##
##   | |__   __ _  __ _| | ___  | |__ __ _  ___| |_ _  ___  _ __  ___    ##
##   |  __| / _` |/ _` | |/ _ \ |  __/ _` |/ __| __| |/ _ \| '_ \/ __|   ##
##   | |___| (_| | (_| | |  __/ | | | (_| | (__| |_| | (_) | | | \__ \   ##
##   |______\__,_|\__, |_|\___| |_|  \__,_|\___|\__|_|\___/|_| |_|___/   ##
##                 __/ |                                                 ##
##                |___/                                                  ##
##                                                                       ##
##                                                                       ##
##                  Simple yet powerful factions plugin                  ##
##                           Version: 1.0.0                              ##
##                                                                       ##
###########################################################################

# Here you can choose a language file that should be used for plugin text messages. Default: english.conf
# Check here what languages are currently available -> https://github.com/Aquerr/EagleFactions/tree/master/common/src/main/resources/assets/eaglefactions/lang
language="en"

# By default, Eagle Factions checks for new available version online and informs about it in the server console at startup.
# Also, it informs players with "eaglefactions.admin.version.notify" permission about new version available when they join the game.
version-check=true

storage {
    # Which storage type should be used?
    # Available storage types (default: hocon):
    # - "hocon" (Recommended)
    # - "h2"    (Recommended)
    # - "sqlite"
    # - "mysql"
    # - "mariadb"
    type="hocon"

    # If you are using a SQL database then you can setup a username and password for your connection here.
    username="sa"
    password="admin"

    # Database url. If you are using MySQL then this field will be used to determine the url of the database. E.g. localhost:3306/ + database-file-name
    # All other databases are stored in eaglefaction's config folder. NOTE: This must end with "/" as name is then added to this url.
    database-url="//localhost:3306/"

    # Database file name. Default: "eaglefactions"
    database-file-name="eaglefactions"
}

#######################################################
#                                                     #
#                     Gamestyle                       #
#                                                     #
#######################################################

# Allow faction's chest? Faction chest is a simple "ender chest" that every faction member has access to by typing "/f chest". Default: true
faction-chest=true

# Turn on friendlyfire in factions? Default: false
friendlyfire-faction=false

# Turn on friendlyfire between truces? Default: true
friendlyfire-truce=true

# Turn on friendlyfire between alliances? Default: false
friendlyfire-alliance=false

# Should Attack Command be available only at night? Default: false
attack-only-at-night=false

# What percentage of its max power a faction needs to have so that other factions are able to attack it with /f attack command. Default: 20 (percentage)
# Example: Let's say, faction max power is 50 and the attack-min-power-percentage=20. Then such faction will need to have 10 power to be vulnerable to get attacked.
attack-min-power-percentage=20

# How much time should it take to destroy enemy claim (in seconds)? Default: 10
attack-time=10

# Informs the attacked faction about what claim is being attacked by an enemy. Default: true
inform-about-attack=true
# Shows coordinates of the attacked claim to the attacked faction. Default: true
show-attacked-claim=true
# Show attack in bossbar? (If 'false' then seconds will be shown in action bar) Default: true
show-attack-in-bossbar=true

#Informs the attacked faction about destroyed claim (after successful attack). Default: true
inform-about-destroy=true
# Shows the coordinates of the destroyed claim to the attacked faction. Default: true
show-destroyed-claim=true

# Block entering to faction's land if players of that faction are offline. Default: true
block-entering-faction-while-offline=true

# Block entering SafeZone territory from WarZone territory. Default: false
block-safezone-from-warzone=false

# Percentage damage reduction that player is getting in his/her own territory. Default: 10.
percentage-damage-reduction-in-own-territory=10

# Here you can turn on/off PVP-Logger & change the time (seconds)
# when player will be able to disconnect after being attacked.
pvp-logger {
    active=true
    time=60

    # Should timer be shown in the scoreboard (sidebar)? Default: true
    show-in-scoreboard=true

    # Here you can block commands during the fight
    # You can specify commands by writing them with slash "/" or without it. For example -> "/f home" or "f home" will give the same result
    # "*" = blocks all commands
    blocked-commands-during-fight=[
        "/f home",
        "spawn",
        "tpa",
        "/tp"
    ]
}

# Factions which have been inactive for some amount of time will be removed.
# Suffix determines the type of time: d = days, h = hours, m = minutes, s = seconds (Default: 0)
# "10d" = factions will be deleted after 10 days
# "0" = factions will not be deleted
factions-remover {
    max-inactive-time="0"

    # Should EF send notification to the server on faction removal?
    notify-when-removed=true

    # Should EF regenerate chunks claimed by faction on faction removal?
    regenerate-when-removed=false
}

# Here you can specify what commands will be blocked when player enters other factions territory
# You can specify commands by writing them with slash "/" or without it. For example -> "/f home" or "f home" will give the same result
# Regex patterns are supported.
blocked-commands-in-other-faction-territory=[]

#######################################################
#                                                     #
#                   Faction Options                   #
#                                                     #
#######################################################

faction {

    name {
        # This determines the maximum amount of characters a Faction's name can be. Default: 30
        max-length=30
        # This determines the minimum amount of characters a Faction's name can be. Default: 3
        min-length=3
    }

    tag {
        # This determines the maximum amount of characters a Faction's tag can be. Default: 5
        max-length=5
        # This determines the minimum amount of characters a Faction's tag can be. Default: 2
        min-length=2
    }

    # Describes faction creation cost.
    creation-cost {

        # The costs list. It can contain multiple costs.
        # Built-in cost types are: power, having-power, items.
        # See the comments below on how to add them.
        # Default: no cost (empty list)
        costs=[

            # Current list contains: 35 orange wool, 20 wooden oak planks, 4 iron ingots.
            # Add every item/block in format minecraft:orange_wool|42 where minecraft:orange_wool is an item/block id and 42 is the quantity.
            ##        {
            ##            type=items,
            ##            value=[
            ##                "minecraft:orange_wool|35",
            ##                "minecraft:oak_planks|20",
            ##                "minecraft:iron_ingot|4"
            ##            ]
            ##        },

            # Having power cost. Basically means that the player creating the faction must have the specified amount of power to create the faction.
            # The power will NOT be taken from player.
            ##        {
            ##            type=having-power,
            ##            value=20
            ##        },

            # Power cost. Takes power from player as a payment for creating the faction.
            ##        {
            ##            type=power,
            ##            value=2
            ##        }

            # Other plugins/addons may add their own payment methods, for example money payment.
        ]
    }

    player-limit {
        # Turns on/off player limit in factions. Default: false
        enabled=false
        # Player limit in the faction. Default: 15
        limit=15
    }

    # Default ranks iniside factions.
    # You can edit it to make new factions start with different ranks and permissions.
    # Note: There are two special ranks that must ALWAYS exist. It is the "default" rank and "leader".
    # "default" = given for new players in faction or when they do not have any rank.
    # "leader" = given for faction leader/owner.
    default-ranks {
        ranks=[
            {
                # The unique name of the rank. Used in commands and storage.
                # "leader" rank must always exists. If you want, change its display_name instead.
                name=leader

                # The display name. Displayed in the chat. Setting it to "" will make it not display.
                display_name="&6Leader"

                # Rank's in-faction permissions. For example, allow block placement/destroy, sending invites, rank management etc,
                permissions=[
                    INTERACT,
                    BLOCK_PLACE,
                    BLOCK_DESTROY,
                    TERRITORY_CLAIM,
                    ATTACK,
                    INVITE_PLAYERS,
                    VIEW_FACTION_CHEST,
                    MANAGE_RANKS,
                    ASSIGN_RANKS,
                    MANAGE_INTERNAL_CLAIMS,
                    KICK_MEMBERS,
                    MANAGE_FACTION_HOME,
                    MANAGE_MOTD,
                    MANAGE_DESCRIPTION,
                    MANAGE_IS_PUBLIC,
                    MANAGE_TAG_NAME,
                    MANAGE_TAG_COLOR,
                    MANAGE_RELATIONS,
                    RENAME_FACTION,
                    INTERNAL_CLAIM_BYPASS_ACCESS
                ]

                # Rank's position in ladder. Higher number means higher position in faction/guild.
                # NOTE: There should NEVER be two ranks with same ladderPosition.
                ladder_position=1000

                # Determines if the rank should be displayed in the chat before player's nickname.
                display_in_chat=true
            },
            {
                name=officer
                display_name="&6Officer"
                permissions=[
                    INTERACT,
                    BLOCK_PLACE,
                    BLOCK_DESTROY,
                    TERRITORY_CLAIM,
                    ATTACK,
                    INVITE_PLAYERS,
                    KICK_MEMBERS,
                    VIEW_FACTION_CHEST,
                    ASSIGN_RANKS,
                    MANAGE_FACTION_HOME,
                    MANAGE_MOTD,
                    MANAGE_DESCRIPTION,
                    MANAGE_RELATIONS,
                    MANAGE_INTERNAL_CLAIMS
                ]
                ladder_position=75
                display_in_chat=true
            },
            {
                name=member
                display_name="&6Member"
                permissions=[
                    INTERACT,
                    BLOCK_PLACE,
                    BLOCK_DESTROY,
                    VIEW_FACTION_CHEST
                ]
                ladder_position=50
                display_in_chat=true
            },
            {
                name=default # "default" rank must always exists. If you want, change its display_name instead.
                display_name="&6Recruit"
                permissions=[
                    INTERACT,
                    BLOCK_PLACE,
                    BLOCK_DESTROY
                ]
                ladder_position=-1000
                display_in_chat=true
            }
        ]
    }
}

#######################################################
#                                                     #
#                Claims & Territories                 #
#                                                     #
#######################################################

# Should blocks in Wilderness be protected from players? Default: false
# When switched to "true", players need to claim territory first to build in it.
protect-wilderness-from-players=false

# Should blocks in WarZone be protected from other players? Default: true
protect-warzone-from-players=true

# Allow explosions by other players in claims. If turned on, TNT cannons can be used to destroy others claims etc. Default: false
allow-explosions-by-other-players-in-claims=false

# Should map command display player's faction's claims only? NOTE: SafeZone and WarZone is always visible. Default: false
show-only-player-faction-claims-in-map=false

# Display entering faction phrase? Default: true
show-faction-enter-phrase=true

# Require connected claims while claiming? Default: false
connected-claims=false

# Here you can toggle claiming territories by items. Simply change "enabled" value to true.
# You can set up which items should be taken from the player in the list below.
claiming-cost {

    # The costs list. It can contain multiple costs.
    # Built-in cost types are: power, having-power, items.
    # See the comments below on how to add them.
    # Default: no cost (empty list)
    costs=[

    # Current list contains: 35 orange wool, 20 wooden oak planks, 4 iron ingots.
    # Add every item/block in format minecraft:orange_wool|42 where minecraft:orange_wool is an item/block id and 42 is the quantity.
    ##        {
    ##            type=items,
    ##            value=[
    ##                "minecraft:orange_wool|35",
    ##                "minecraft:oak_planks|20",
    ##                "minecraft:iron_ingot|4"
    ##            ]
    ##        },

    # Having power cost. Basically means that the player creating the faction must have the specified amount of power to create the faction.
    # The power will NOT be taken from player.
    ##        {
    ##            type=having-power,
    ##            value=20
    ##        },

    # Power cost. Takes power from player as a payment for creating the faction.
    ##        {
    ##            type=power,
    ##            value=2
    ##        }

    # Other plugins/addons may add their own payment methods, for example money payment.
    ]
}

# Here you can edit the time (in seconds) before a territory will be claimed.
delayed-claim {
    enabled=false
    claiming-time=10
}

# Here you can specify which items and blocks will NOT be affected by the protection system.
# Regex patterns are supported.
# E.g. enderio:.* will whitelist all items and blocks from Ender IO.
# E.g. thermal.*:.* will whitelist all items and blocks from any mod that starts with word "thermal"
allowed-items-and-blocks {
    safe-zone {
        # Here you can specify which items players will be able to use in protected territory.
        items-whitelist=[
            "minecraft:iron_sword"
        ]

        # Here you can specify which blocks players will be able to place and destroy
        place-destroy-whitelist=[
            ""
        ]

        # Here you can specify which blocks players will be able to interact with. E.g. machines.
        interact-whitelist=[
            "enderio:windmill"
        ]
    }

    war-zone {
        items-whitelist=[
            "minecraft:iron_sword"
        ]

        place-destroy-whitelist=[
            ""
        ]

        interact-whitelist=[
            "enderio:windmill"
        ]
    }

    normal-faction {
        items-whitelist=[
            "minecraft:iron_sword"
        ]

        place-destroy-whitelist=[
            ""
        ]

        interact-whitelist=[
            "enderio:windmill"
        ]
    }

    wilderness {
        items-whitelist=[
            ""
        ]

        place-destroy-whitelist=[
            ""
        ]

        interact-whitelist=[
            ""
        ]
    }
}

#######################################################
#                                                     #
#                       Chat                          #
#                                                     #
#######################################################

# What prefix should be displayed in chat when someone will send a message. Default: tag
# Available Options: "tag", "name", "none"
faction-prefix=tag

# Should faction's prefix show fist in the message or faction's rank? Default: true
# Change it to false if you want faction's rank to be displayed first.
faction-prefix-first-in-chat=true

# Allow coloring factions tags? Default: true
colored-tags-allowed=true

# Here you can edit characters that shows on the chat before and after factions prefix. For example: [TAG]
# You can even color these character by using ampersand color codes. For example: "&4[" will give you a red square bracket [
faction-prefix-start="&r["
faction-prefix-end="&r]"

# Default tag color (used for newly created factions and also when colored-tags-allowed=false)
# See the full list of available colors here https://github.com/KyoriPowered/adventure/blob/main/4/api/src/main/java/net/kyori/adventure/text/format/NamedTextColor.java
default-tag-color="GREEN"

# The chat prefix of non-faction player. Default: None.
# You need to explicitly write here square brackets "[" and "]" if you want them in the prefix.
# Minecraft color codes are supported.
non-faction-player-prefix=""

# Should messages from other factions be visible in the chat while switching to "faction" or "alliance" chat?
suppress-other-factions-messages-while-in-team-chat=false

# Display messages from protection system in the chat?
# If turned off, messages like "You don't have access to do this" will not be shown in the chat.
# Default: true
display-protection-system-messages=true

# Display faction tags in tablist (the table you see when you by default press TAB).
# If you are using other plugins for modyfing tablists, consider setting this value to false.
# Default: true
display-faction-tags-in-tablist=true

#######################################################
#                                                     #
#                       Power                         #
#                                                     #
#######################################################

power {
    # How much power will be removed on player death. Default: 2.0
    decrement=2.0
    # How much power will be restored for player after 1 minute of playing. (0.04 per minute = 1,2 per hour.) Default: 0.04
    increment=0.04
    # Player kill award. Default: 2.0
    kill-award=2.0
    # Penalty after killing a teammate. Default: 1.0
    penalty=1.0
    # Starting amount of power. Default: 5.0
    start-power=5.0
    # Maximum amount of power a player can have. Default: 10.0
    max-power=10.0
}

#######################################################
#                                                     #
#                  Spawning & Home                    #
#                                                     #
#######################################################

# Can faction home be placed outside the faction claim? Default: false
home {
    # Time (seconds) you need to wait to use home command again.
    cooldown=60

    # Time (seconds) you need to stay still after using /f home
    delay=5

    # Should it be possible to teleport to faction's home from other worlds?
    teleport-between-worlds=false

    # Can faction home be placed outside the faction claim? Default: false
    can-place-outside-faction-claim=false

    # Should player be spawned at faction's home after death? Default: false
    spawn-at-home-after-death=false

    # Extra feature which after toggling on blocks teleporting to faction's home if a player just died in own faction's territory.
    block-home-after-death-in-own-faction {
        enabled=false
        block-time=60
    }

    # Animation options, enabled by default. Disabling may increase performnace.
    teleport-animation {

        # Teleport animation (particles) at source (player) location
        source {
            enabled=true
        }

        # Teleport animation (particles) at destination (home) location
        destination {
            enabled=true
        }
    }
}

#######################################################
#                                                     #
#                  Dynmap Integration                 #
#                                                     #
#######################################################

dynmap {
    # Enables Dynmap Integration
    enabled=true

    ### Customization (you can pick the colors on HEX color picker)
    # Color of the normal faction
    # NOTE: When colored-tags-allowed=true then faction's tag color is used as faction's area color.
    # When colored-tags-allowed=false then the color from this node is used.
    faction-color=0x00FF00

    # Color of SafeZone faction
    safezone-color=0x800080

    # Color of WarZone faction
    warzone-color=0xFF0000

    # Icon of the faction home marker. Full icon list is located at
    # https://github.com/webbukkit/DynmapCore/blob/master/src/main/java/org/dynmap/markers/impl/MarkerAPIImpl.java#L65-L74
    faction-home-marker="greenflag"

    ### Factions privacy (Information showed in faction description showed in an infowindow)

    # Shows the faction's leader
    show-faction-leader=true

    # Shows info about faction members
    members-info=true
}

#######################################################
#                                                     #
#                  Bluemap Integration                #
#                                                     #
#######################################################

bluemap {
    # Enables BlueMap Integration
    enabled=true

    ### Customization (you can pick the colors on HEX color picker)
    # Color of the normal faction
    # NOTE: When colored-tags-allowed=true then faction's tag color is used as faction's area color.
    # When colored-tags-allowed=false then the color from this node is used.
    faction-color=0x00FF00

    # Color of SafeZone faction
    safezone-color=0x800080

    # Color of WarZone faction
    warzone-color=0xFF0000

    # Icon of the faction home marker. Full icon list is located at
    faction-home-marker="greenflag"

    ### Factions privacy (Information showed in faction description showed in an infowindow)

    # Shows the faction's leader
    show-faction-leader=true

    # Shows info about faction members
    members-info=true
}

Next page: Power System