Skip to content

Configuration

Miroslav Vasilev edited this page Oct 8, 2020 · 8 revisions

Example Configuration

Here is an example configuration for the AtherysTowns plugin

economy-enabled=false
max-residents-to-display=25
min-residents-to-create-town=3
nation {
    generate-roles=true
    max-nation-name-size=25
    nation-default-role=citizen
    nation-leader-role=leader
    roles {
        citizen {
            name=Citizen
            nation-permissions=[
                "atherystowns.nation.deposit",
                "atherystowns.nation.chat"
            ]
        }
        leader {
            name=Leader
            nation-permissions=[
                "atherystowns.nation.invite",
                "atherystowns.nation.kick",
                "atherystowns.nation.permission",
                "atherystowns.nation.role",
                "atherystowns.nation.withdraw",
                "atherystowns.nation.deposit",
                "atherystowns.nation.chat",
                "atherystowns.nation.add_ally",
                "atherystowns.nation.add_enemy",
                "atherystowns.nation.add_neutral"
            ]
        }
    }
}
nation-chat-prefix="&f[&eN&f]&r"
raid {
    town-raid-boss-bar-distance=20
    town-raid-cooldown="1m"
    town-raid-cost=500.0
    town-raid-damage-per-spawn=50
    town-raid-distance-between-points=150
    town-raid-duration="1m"
    town-raid-health=500.0
    town-raid-max-creation-distance=500
    town-raid-min-creation-distance=20
    town-raid-skin-uuid=b1759db2-3b7f-4d5d-9155-70aca6e94cba
    town-raid-spawn-radius=450
}
respawn-in-town=true
taxes {
    area-oversize-tax-amount=10
    area-tax-amount=10
    base-tax-amount=100
    inactive-resident-duration="14d"
    max-nation-multiplier=1.0
    max-tax-failures-before-ruin=1
    min-nation-multiplier=0.1
    resident-tax-amount=5
    tax-collection-interval="1m"
    tax-timer-interval-minutes=1
}
town {
    default-town-max-size=4096
    generate-roles=true
    local-transactions=false
    max-town-name-size=25
    plot-max-area=1024
    plot-min-side=16
    roles {
        mayor {
            name=Mayor
            town-permissions=[
                "atherystowns.town.ruin",
                "atherystowns.town.raid.start",
                "atherystowns.town.raid.cancel",
                "atherystowns.town.invite",
                "atherystowns.town.kick",
                "atherystowns.town.plot.claim",
                "atherystowns.town.plot.unclaim",
                "atherystowns.town.plot.grant",
                "atherystowns.town.permission",
                "atherystowns.town.withdraw",
                "atherystowns.town.deposit",
                "atherystowns.town.nation",
                "atherystowns.town.name",
                "atherystowns.town.description",
                "atherystowns.town.motd",
                "atherystowns.town.color",
                "atherystowns.town.joinable",
                "atherystowns.town.setspawn",
                "atherystowns.town.pvp",
                "atherystowns.town.role",
                "atherystowns.town.leader",
                "atherystowns.town.chat"
            ]
            world-permissions=[
                "atherystowns.world.build",
                "atherystowns.world.destroy",
                "atherystowns.world.damage.nonplayers",
                "atherystowns.world.damage.players",
                "atherystowns.world.interact.tile",
                "atherystowns.world.interact.doors",
                "atherystowns.world.interact.redstone",
                "atherystowns.world.interact.entities",
                "atherystowns.world.spawn.entities"
            ]
        }
        resident {
            name=Resident
            town-permissions=[
                "atherystowns.town.deposit",
                "atherystowns.town.chat"
            ]
            world-permissions=[
                "atherystowns.world.build",
                "atherystowns.world.destroy",
                "atherystowns.world.damage.nonplayers",
                "atherystowns.world.damage.players",
                "atherystowns.world.interact.tile",
                "atherystowns.world.interact.doors",
                "atherystowns.world.interact.redstone",
                "atherystowns.world.interact.entities",
                "atherystowns.world.spawn.entities"
            ]
        }
    }
    town-default-role=resident
    town-leader-role=mayor
    town-spawn-cooldown-minutes=0
    town-spawn-warmup-seconds=0
}
town-chat-prefix="&f[&bT&f]&r"

Town & Nation Roles

In the AtherysTowns config, there is the ability to configure Town and Nation roles. AtherysTowns depends on a permission management plugin being present for these roles to work. We recommend the LuckPerms plugin.

There are 2 roles configurations, one for town roles and one for nation roles. They are found under town.roles and nation.roles respectively. You can find the examples above. Each role is a group of permissions that are bundled together under a common name. There are differences between nation roles and town roles in terms of which permissions can be assigned to which roles. There are permissions that are intended for nation roles, and permissions that are intended for town roles.

  • Town Roles have Town Permissions and World Permissions
  • Nation Roles have only Nation Permissions.

World Permissions

World permissions are related to actions that the player can take in Minecraft. Breaking blocks, placing blocks, interacting with redstone, tile entities and others. These can also be used with the /plot permission commands to allow or deny specific players or player groups access to a plot. Here is a list of all world permissions:

Permission Description
atherystowns.world.build Ability to place blocks
atherystowns.world.destroy Ability to destroying blocks
atherystowns.world.damage.nonplayers Ability to damage non-player entities
atherystowns.world.damage.players Ability to damage other players
atherystowns.world.interact.doors Ability to interact with doors
atherystowns.world.interact.redstone Ability to interact with redstone
atherystowns.world.interact.tile Ability to interact with tile entities ( Chests, Furnaces, etc. )
atherystowns.world.interact.entities Ability to interact with entities ( milking a cow, shearing a sheep, etc. )
atherystowns.world.spawn.entities Ability to spawn entities

Town Permissions

Nation Permissions

Clone this wiki locally