Skip to content
LimeByte edited this page Sep 18, 2013 · 34 revisions

BattleNight will automatically generate the configuration files if they do not exist when the server is started or reloaded.

BattleNight will run fine without touching any of these settings but if you want to customize how BattleNight runs on your server or change/create classes then you're in the right place.

As I use YAML for all the configuration files, you will need to make sure you are using 4 spaces instead of tabs. Also I would recommend running the edited file through a YAML parser to check for any mistakes.

Config.yml

This is the main config file where you edit the general preferences for BattleNight. It is located in the plugins/BattleNight folder which is relative to your craftbukkit.jar file.

Default file (top)

# BattleNight Version: 1.9.2
# Main Configuration File

Battle:
    Type: TDM
    Duration: 300
    MinPlayers: 2
    MaxPlayers: 0
UsePermissions: false
ReadyBlock: iron-block
FriendlyFire: false
StopHealthRegen: true
ExitWaypoint: false
Teleportation:
    EnderPearls: true
    Portals: true
    Commands: false
    Plugins: false
    Unknown: true
Particles:
    ClassSelection: smoke
Scoreboard:
    DisplayHealth: true
Commands:
    Block: true
    Whitelist:
    - list
    - me
    - toggledownfall
    - stop
    - reload
UpdateCheck: true
Debug: false

Description table (top)

Node Description Default
Battle.Type What type of battle to use. Options are TDM and FFA. TDM
Battle.Duration How long a battle should last in seconds. 300
Battle.MinPlayers The minimum amount of players required for a battle to start. 2
Battle.MaxPlayers The maximum amount of players allowed in a battle, 0 being unlimited. 0
UsePermissions Whether to use SuperPerms instead of standard/op permissions. false
ReadyBlock The Material for the block users need to hit to "ready up". iron-block (Iron Block)
FriendlyFire Whether players can hurt team mates. false
StopHealthRegen Prevent users from regaining health. true
Teleportation.EnderPearls Whether players can use Ender Pearls. true
Teleportation.Portals Whether players can use portals. false
Teleportation.Commands Whether players can teleport by using commands. false
Teleportation.Plugins Whether plugins other than BattleNight can teleport the player. false
Teleportation.Unknown Whether unknown teleport causes can teleport the player. false
Particles.ClassSelection What particle type to use when players select a class. Options are smoke, ender and none. smoke
Commands.Block Prevent users from performing non-whitelisted commands. true
Commands.Whitelist Permitted commands if Commands.Block is enabled. See default config
UpdateCheck Whether to check for updates on start. true
Debug Whether to print debug messages to the console. false

Classes.yml

This file is where you can edit or create custom classes. It is located in the plugins/BattleNight folder which is relative to your craftbukkit.jar file.

Default file (top)

# BattleNight Version: 1.9.2
# Classes Configuration File

classes:
    Scout:
        items:
            slot0:
                type: stone_sword
                enchantments: knockback~2
            slot1:
                type: potion
                data: 8262
        armour:
            boots:
                type: iron_boots
                enchantments: protection_fall~4
        effects: speed~2, jump~2
    Pyro:
        items:
            slot0:
                type: wood_sword
                enchantments: fire_aspect~2
            slot1:
                type: flint_and_steel
            slot3:
                type: tnt
                amount: 8
        armour:
            helmet:
                type: leather_helmet
                enchantments: protection_fire~4
            chestplate:
                type: leather_chestplate
                enchantments: protection_fire~4
            leggings:
                type: leather_leggings
                enchantments: protection_fire~4
            boots:
                type: leather_boots
                enchantments: protection_fire~4
        effects: fire_resistance~1
    Tank:
        items:
            slot0:
                type: stone_sword
        armour:
            helmet:
                type: diamond_helmet
                enchantments: protection_explosions~3
            chestplate:
                type: diamond_chestplate
                enchantments: protection_explosions~3
            leggings:
                type: diamond_leggings
                enchantments: protection_explosions~3
            boots:
                type: diamond_boots
                enchantments: protection_explosions~3
        effects: slow~1
    Swordsman:
        items:
            slot0:
                type: diamond_sword
                enchantments: damage_all~1
    Archer:
        items:
            slot0:
                type: bow
                enchantments: arrow_infinite~1, arrow_knockback~2
                name: Long Bow
            slot1:
                type: ender_pearl
                amount: 4
            slot8:
                type: arrow
        armour:
            helmet:
                type: chainmail_helmet
                enchantments: protection_projectile~2
            chestplate:
                type: chainmail_chestplate
                enchantments: protection_projectile~2
            leggings:
                type: chainmail_leggings
                enchantments: protection_projectile~2
            boots:
                type: chainmail_boots
                enchantments: protection_projectile~2
    Medic:
        items:
            slot0:
                type: gold_sword
                enchantments: knockback~2
                name: Rusty Syringe
            slot1:
                type: golden_apple
            slot7:
                type: potion
                data: 16389
                amount: 8
            slot8:
                type: potion
                data: 16385
                amount: 2
        armour:
            helmet:
                type: leather_helmet
                enchantments: protection_environmental~2
                colour: 177, 93, 155
    Magician:
        items:
            slot0:
                type: stick
                name: Magic Staff
                enchantments: damage_all~4, knockback~1
            slot1:
                type: ender_pearl
                amount: 16
            slot5:
                type: potion
                data: 16386
            slot6:
                type: potion
                data: 16396
                amount: 32
            slot7:
                type: potion
                data: 16388
                amount: 8
            slot8:
                type: potion
                data: 16458
        armour:
            helmet:
                type: iron_helmet
            chestplate:
                type: iron_chestplate
            leggings:
                type: iron_leggings
            boots:
                type: iron_boots
                enchantments: protection_fall~4
    Spy:
        items:
            slot0:
                type: iron_sword
                name: Dagger
            slot1:
                type: potion
                data: 8206
        effects: speed~1, water_breathing~1
    Miner:
        items:
            slot0:
                type: diamond_pickaxe
                enchantments: damage_all~2
                name: Sharpened Pick
            slot1:
                type: potion
                data: 8225
                amount: 4
        armour:
            helmet:
                type: leather_helmet
                enchantments: protection_environmental~3
            chestplate:
                type: leather_chestplate
                enchantments: protection_environmental~3
            leggings:
                type: leather_leggings
                enchantments: protection_environmental~3
            boots:
                type: leather_boots
                enchantments: protection_environmental~3
        effects: fast_digging~2
    Dwarf:
        items:
            slot0:
                type: diamond_axe
                enchantments: damage_all~3
                name: Battle Axe
        armour:
            helmet:
                type: leather_helmet
            chestplate:
                type: leather_chestplate
            leggings:
                type: leather_leggings
            boots:
                type: leather_boots
        effects: speed~2, slow_digging~8

Items (top)

Each class has a set of items and armour. They sorted by the inventory slot they will appear in, items using slot0 to slot35 and armour using helmet, chestplate, leggings and boots. Each item has a range of possible attributes with only type being required. Please take note that with some items not all attributes will work, e.g. the colour attribute will only work for leather armour.

Item Attributes

Type

type: <item name>

Item names can be found on the list of materials. Item IDs can also be used and they will be converted for you.

Example:

items:
    slot0:
        type: iron-sword

This adds a simple Iron Sword to the first slot.

Data

data: <data>

The data attribute can be used to add data to an item. The most common use of this is for potions. For potion IDs and data values check out my potion list.

Example:

items:
    slot1:
        type: potion
        data: 8259

This adds a single 8 minute Fire Resistance Potion to the second slot.

Amount

items:
    slot1:
        type: potion
        data: 8259
        amount: 6

This adds six 8 minute Fire Resistance Potion to the second slot.

Enchantments

enchantments: <enchantment>~<level>

Enchantment names can be found on the list of enchantments.

Example:

items:
    slot0:
        type: iron-sword
        enchantments: knockback~2

This adds an Iron Sword enchanted with Knockback II.

Colour

colour: <red>, <green>, <blue>

Example:

armour:
    leggings:
        type: leather-helmet
        colour: 153, 178, 242

This adds light blue coloured leather leggings.

Metrics.yml

This is the metrics config file where you edit the preferences for [Plugin Metrics]. It is located in the plugins/BattleNight folder which is relative to your craftbukkit.jar file.

Default file (top)

# BattleNight Version: 1.9.2
# Metrics Configuration File

opt-out: false
guid: <Your servers GUID>

Description table (top)

Node Description Default
opt-out Whether to opt out of submitting helpful BattleNight usage stats to [PluginMetrics]. false
guid The generated UID for your server. N/A