Got a question that the wiki doesn't answer? Ask on the forum (preferred), or join us on IRC.

CreeperHost
About the ads

CraftBook/Configuration

From EngineHub.org Wiki
Jump to: navigation, search

If you are looking for installation information please check the installation page.

Contents


Configuration

Global Configuration

Configuration Node and Path Default Value Effect
enable-circuits true If this is set to false, all circuit mechanics will be disabled, and circuit configuration will not do anything.
enable-mechanisms true If this is set to false, all mechanics will be disabled, and mechanism configuration will not do anything.
enable-vehicles true If this is set to false, all vehicles mechanics will be disabled, and vehicle configuration will not do anything.
st-think-ticks 2 WARNING! Changing this can result in all ST mechanics acting very weirdly, only change this if you know what you are doing!
notify-updates true Enables the update notifier. This checks for updates on start, and notifies anyone with the permission when they join. They can then use /cb update to download the update.
safe-destruction true Causes many mechanics to require sufficient blocks to function, for example gates, bridges and doors.
no-op-permissions false If on, OP's will not default to have access to everything.
indirect-redstone false Allows redstone not directly facing a mechanism to trigger said mechanism.
use-block-distance false Rounds all distance equations to the block grid.
check-worldguard-flags true Checks to see if WorldGuard allows building/using in the area when activating mechanics.
advanced-block-checks true Use advanced methods to detect if a player can build or not. Use this if you use region protections other than WorldGuard, or experience issues with WorldGuard protection. This can add extra entries to Block Logging plugins when a mechanic is broken/placed.
pedantic-block-checks false In conjunction with advanced-block-checks, this option adds a few extra checks if you are experiencing compatibility issues with certain plugins that stop breaks/places/interacts.
sign-click-timeout 10 Make sure a player can only press signs so often.
language en_US The default language for CraftBook. Note: This language needs to be in the 'languages' field for this to work.
languages [en_US] A list of languages supported by craftbook, if a user requests a language not listed... They will see default.
scan-text-for-localization false If enabled, CraftBook will scan messages sent to players for localizable text, instead of just checking if the entire message is localizable.
debug-mode false Enable a mode that will print extra debug information to the console.
debug-flags [] Enable certain debug types when debug mode is enabled.
easter-eggs true Enables random easter eggs. Can be from console messages on startup for a special occasion, to funny little effects with IC's and other mechanics (Always harmless, won't mess anything up)
realistic-randoms false Random numbers are much more random, with a small cost to CPU usage.
show-permission-messages true Show messages when a player does not have permission to do something.
persistent-storage-type YAML PersistentStorage stores data that can be accessed across server restart. Method of PersistentStorage storage (Note: DUMMY is practically off, and may cause issues). Can currently be any of the following: YAML, DUMMY

Mechanic Configuration

AI Mechanic Configuration

Configuration Node and Path Default Value Effect
mechanics.ai.enable false Enable AI Mechanics.
mechanics.ai.vision-enable [Zombie, PigZombie] The list of entities to enable vision AI mechanics for.
mechanics.ai.crit-bow-enable [Skeleton] The list of entities to enable bow critical AI mechanics for.
mechanics.ai.attack-passive-enable [Zombie] The list of entities to enable attack passive AI mechanics for.

Ammeter Configuration

Configuration Node and Path Default Value Effect
mechanics.ammeter.enable false Enables the ammeter tool.
mechanics.ammeter.item COAL Set the item that is the ammeter tool.

Better Leads Configuration

Configuration Node and Path Default Value Effect
mechanics.better-leads.enable false Enables BetterLeads Mechanics.
mechanics.better-leads.stop-mob-target false Stop hostile mobs targeting you if you are holding them on a leash.
mechanics.better-leads.owner-unleash-only false Only allow the owner of tameable entities to unleash them from a leash hitch.
mechanics.better-leads.hitch-persists false Stop leash hitches breaking when clicked no entities are attached. This allows for a public horse hitch or similar.
mechanics.better-leads.mob-repel false If you have a mob tethered to you, mobs of that type will not target you.
mechanics.better-leads.allowed-mobs [ZOMBIE, SPIDER] The list of mobs that can be tethered with a lead.

Better Physics Configuration

Configuration Node and Path Default Value Effect
mechanics.better-physics.enable false Enables BetterPhysics Mechanics. (This must be enabled for any sub-mechanic to work)
mechanics.better-physics.falling-ladders true Enables BetterPhysics Falling Ladders.

Better Pistons Configuration

Configuration Node and Path Default Value Effect
mechanics.better-pistons.enable false Enables BetterPistons Mechanics. (This must be enabled for any sub-mechanic to work)
mechanics.better-pistons.crushers true Enables BetterPistons Crusher Mechanic.
mechanics.better-pistons.crushers-kill-mobs false Causes crushers to kill mobs as well as break blocks. This includes players.
mechanics.better-pistons.crusher-blacklist [OBSIDIAN, BEDROCK] A list of blocks that the Crusher piston can not break.
mechanics.better-pistons.super-sticky true Enables BetterPistons SuperSticky Mechanic.
mechanics.better-pistons.super-push true Enables BetterPistons SuperPush Mechanic.
mechanics.better-pistons.movement-blacklist [OBSIDIAN, BEDROCK] A list of blocks that the movement related BetterPistons can not interact with.
mechanics.better-pistons.bounce true Enables BetterPistons Bounce Mechanic.
mechanics.better-pistons.bounce-blacklist [OBSIDIAN, BEDROCK] A list of blocks that the Bounce piston can not bounce.
mechanics.better-pistons.max-distance 12 The maximum distance a BetterPiston can interact with blocks from.

Better Plants Configuration

Configuration Node and Path Default Value Effect
mechanics.better-plants.enable false Enables BetterPlants Mechanics. (This must be enabled for any sub-mechanic to work)
mechanics.better-plants.fern-farming true Allows ferns to be farmed by breaking top half of a large fern. (And small ferns to grow)

Bridges Configuration

Configuration Node and Path Default Value Effect
mechanics.bridge.enable false Enable bridges.
mechanics.bridge.allow-redstone true Enable bridges via redstone.
mechanics.bridge.max-length 30 Max length of a bridge.
mechanics.bridge.max-width 5 Max width either side. 5 = 11, 1 in middle, 5 on either side.
mechanics.bridge.blocks [COBBLESTONE, WOOD, GLASS, DOUBLE_STEP, WOOD_DOUBLE_STEP] Blocks bridges can use.

Cauldron Configuration

Configuration Node and Path Default Value Effect
mechanics.cauldron.enable true Enable the cauldron mechanic.
mechanics.cauldron.spoons true Require spoons to cook cauldron recipes.
mechanics.cauldron.enable-redstone false Allows use of cauldrons via redstone.
mechanics.cauldron.item-tracking true Tracks items and forces them to to tracked by the cauldron. Fixes mc bugs by holding item in place.

Chair Configuration

Configuration Node and Path Default Value Effect
mechanics.chair.enable false Enable chair mechanic.
mechanics.chair.allow-holding-blocks false Allow players to sit in chairs when holding blocks.
mechanics.chair.regen-health true Regenerate health when sitting down.
mechanics.chair.blocks [WOOD_STAIRS, COBBLESTONE_STAIRS, BRICK_STAIRS, SMOOTH_STAIRS, NETHER_BRICK_STAIRS, SANDSTONE_STAIRS, SPRUCE_WOOD_STAIRS, BIRCH_WOOD_STAIRS, JUNGLE_WOOD_STAIRS, QUARTZ_STAIRS] A list of blocks that can be sat on.
mechanics.chair.face-correct-direction true When the player sits, automatically face them the direction of the chair. (If possible)
mechanics.chair.require-sign false Require a sign to be attached to the chair in order to work!
mechanics.chair.max-distance 3 The maximum distance between the click point and the sign. (When require sign is on)
mechanics.chair.max-click-radius 5 The maximum distance the player can be from the sign.


Chunk Anchor Configuration

Configuration Node and Path Default Value Effect
mechanics.chunk-anchor.enable false Enable chunk anchors.
mechanics.chunk-anchor.enable-redstone true Enable toggling with redstone.
mechanics.chunk-anchor.check-chunks true On creation, check the chunk for already existing chunk anchors.

Command Item Configuration

Configuration Node and Path Default Value Effect
mechanics.command-items.enable false Enables the CommandItems mechanic.

Command Sign Configuration

Configuration Node and Path Default Value Effect
mechanics.command-sign.enable false Enable command signs.
mechanics.command-sign.allow-redstone true Enable CommandSigns via redstone.

Cooking Pot Configuration

Configuration Node and Path Default Value Effect
mechanics.cooking-pot.enable true Enable cooking pots.
mechanics.cooking-pot.require-fuel true Require fuel to cook.
mechanics.cooking-pot.cook-ores true Allows the cooking pot to cook ores and other smeltable items.
mechanics.cooking-pot.sign-click-open true When enabled, right clicking the [Cook] sign will open the cooking pot.
mechanics.cooking-pot.take-buckets true When enabled, lava buckets being used as fuel will consume the bucket.
mechanics.cooking-pot.super-fast-cooking false When enabled, cooking pots cook at incredibly fast speeds. Useful for semi-instant cooking systems.
mechanics.cooking-pot.allow-redstone true Allows for redstone to be used as a fuel source.

Custom Crafting Configuration

Configuration Node and Path Default Value Effect
mechanics.custom-crafting.enable false Enable custom crafting.

Custom Drop Configuration

Configuration Node and Path Default Value Effect
mechanics.custom-drops.enable false Enable Custom Drops.
mechanics.custom-drops.require-permissions false Require a permission node to get custom drops.

Dispenser Recipe Configuration

Configuration Node and Path Default Value Effect
mechanics.dispenser-recipes.enable false Enables Dispenser Recipes.
mechanics.dispenser-recipes.cannon-enable true Enables Cannon Dispenser Recipe.
mechanics.dispenser-recipes.fan-enable true Enables Fan Dispenser Recipe.
mechanics.dispenser-recipes.fire-arrows-enable true Enables Fire Arrows Dispenser Recipe.
mechanics.dispenser-recipes.snow-shooter-enable true Enables Snow Shooter Dispenser Recipe.
mechanics.dispenser-recipes.xp-shooter-enable true Enables XP Shooter Dispenser Recipe.

Door Configuration

Configuration Node and Path Default Value Effect
mechanics.door.enable false Enables Doors.
mechanics.door.allow-redstone true Allow doors to be toggled via redstone.
mechanics.door.max-length 30 The maximum length(height) of a door.
mechanics.door.max-width 5 Max width either side. 5 = 11, 1 in middle, 5 on either side
mechanics.door.blocks [COBBLESTONE, WOOD, GLASS, DOUBLE_STEP, WOOD_DOUBLE_STEP] A list of blocks that a door can be made out of.

Elevator Configuration

Configuration Node and Path Default Value Effect
mechanics.elevator.enable false Enables the Elevator mechanic.
mechanics.elevator.enable-buttons true Allow elevators to be used by a button on the other side of the block.
mechanics.elevator.allow-looping false Allows elevators to loop the world height. The heighest lift up will go to the next lift on the bottom of the world and vice versa.
mechanics.elevator.smooth-movement false Causes the elevator to slowly move the player between floors instead of instantly.
mechanics.elevator.smooth-movement-speed 0.5 The speed at which players move from floor to floor when smooth movement is enabled.

Footprint Configuration

Configuration Node and Path Default Value Effect
mechanics.footprints.enable false Enable the footprints mechanic.
mechanics.footprints.blocks [DIRT, SAND, SNOW, SNOW_BLOCK, ICE] The list of blocks that footprints appear on.

Gate Configuration

Configuration Node and Path Default Value Effect
mechanics.gate.enable false Enables the gate mechanic.
mechanics.gate.allow-redstone true Allows the gate mechanic to be toggled via redstone.
mechanics.gate.limit-columns true Limit the amount of columns a gate can toggle.
mechanics.gate.max-columns 14 If limit-columns is enabled, the maximum number of columns that a gate can toggle.
mechanics.gate.blocks [FENCE, IRON_FENCE, THIN_GLASS, NETHER_FENCE] The list of blocks that a gate can use.
mechanics.gate.enforce-type true Make sure gates are only able to toggle a specific material type. This prevents transmutation.
mechanics.gate.max-column-height 12 The max height of a column.
mechanics.gate.gate-search-radius 3 The radius around the sign the gate checks for fences in. Note: This is doubled upwards.

Head Drop Configuration

Configuration Node and Path Default Value Effect
mechanics.head-drops.enable false Enables the Head Drops mechanic.
mechanics.head-drops.drop-mob-heads true Allow the Head Drops mechanic to drop mob heads.
mechanics.head-drops.drop-player-heads true Allow the Head Drops mechanic to drop player heads.
mechanics.head-drops.require-player-killed true Only drop heads when killed by a player. Otherwise they will drop heads on any death.
mechanics.head-drops.drop-head-when-mined true When enabled, heads keep their current skin when mined and are dropped accordingly.
mechanics.head-drops.override-natural-head-drops false Override natural head drops, this will cause natural head drops to use the chances provided by CraftBook. (Eg, Wither Skeleton Heads)
mechanics.head-drops.drop-rate 0.05 A value between 1 and 0 which dictates the global chance of heads being dropped. This can be overridden per-entity type.
mechanics.head-drops.looting-rate-modifier 0.05 This amount is added to the chance for every looting level on an item. Eg, a chance of 0.05(5%) and a looting mod of 0.05(5%) on a looting 3 sword, would give a 0.20 chance (20%).
mechanics.head-drops.show-name-right-click true When enabled, right clicking a placed head will say the owner of the head's skin.


Hidden Switch Configuration

Configuration Node and Path Default Value Effect
mechanics.hidden-switch.enable false Enables the Hidden Switch mechanic.
mechanics.hidden-switch.any-side true Allows the Hidden Switch to be activated from any side of the block.

Legacy Cauldron Configuration

Configuration Node and Path Default Value Effect
mechanics.legacy-cauldron.enable false Enables the Legacy Cauldron mechanic.
mechanics.legacy-cauldron.block STONE The block to use as the casing for the legacy cauldron.

Light Switch Configuration

Configuration Node and Path Default Value Effect
mechanics.light-switch.enable false Enables the Light Switch mechanic.
mechanics.light-switch.max-range 10 The maximum range that the mechanic searches for lights in.
mechanics.light-switch.max-lights 20 The maximum amount of lights that a Light Switch can toggle per usage.

LightStone Configuration

Configuration Node and Path Default Value Effect
mechanics.lightstone.enable false Enables the LightStone mechanic.
mechanics.lightstone.item GLOWSTONE_DUST The item that the lightstone mechanic uses.

Marquee Configuration

Configuration Node and Path Default Value Effect
mechanics.marquee.enable false Enables the Marquee mechanic.

Map Changer Configuration

Configuration Node and Path Default Value Effect
mechanics.map-changer.enable false Enables the Map Changer mechanic.

Painting Switcher Configuration

Configuration Node and Path Default Value Effect
mechanics.paintings.enable false Enables the Painting Switcher mechanic.

Payment Configuration

Configuration Node and Path Default Value Effect
mechanics.payment.enable false Enables the Payment mechanic.

Readable Bookshelf Configuration

Configuration Node and Path Default Value Effect
mechanics.bookcase.enable false Enable readable bookshelves.
mechanics.bookcase.read-when-sneaking no Enable reading while sneaking.
mechanics.bookcase.read-when-holding-block false Allow bookshelves to work when the player is holding a block.

Sign Copier Configuration

Configuration Node and Path Default Value Effect
mechanics.sign-copy.enable true Enables the Sign Copy mechanic.
mechanics.sign-copy.item INK_SACK:0 The item the Sign Copy mechanic uses.

Snow Configuration

Configuration Node and Path Default Value Effect
mechanics.snow.enable false Enables the Snow mechanic.
mechanics.snow.piling false Enables the piling feature of the Snow mechanic.
mechanics.snow.trample false Enables the trampling feature of the Snow mechanic.
mechanics.snow.partial-trample-only false If trampling is enabled, only trample it down to the smallest snow.
mechanics.snow.jump-trample false Require jumping to trample snow.
mechanics.snow.place false Allow snowballs to create snow when they land.
mechanics.snow.slowdown false Slows down entities as they walk through thick snow.
mechanics.snow.realistic false Realistically move snow around, creating an 'avalanche' or 'mound' effect.
mechanics.snow.high-piling false Allow piling above the 1 block height.
mechanics.snow.max-pile-height 3 The maximum piling height of high piling snow.
mechanics.snow.replacable-blocks [DEAD_BUSH, LONG_GRASS, YELLOW_FLOWER, RED_ROSE, BROWN_MUSHROOM, RED_MUSHROOM, FIRE] A list of blocks that can be replaced by realistic snow.
mechanics.snow.falldown-animation-speed 5 The fall animation speed of realistic snow.
mechanics.snow.freeze-water false Should snow freeze water?
mechanics.snow.melt-in-sunlight false Enables snow to melt in sunlight.

Teleporter Configuration

Configuration Node and Path Default Value Effect
mechanics.teleporter.enable false Enables the Teleporter mechanic.
mechanics.teleporter.require-sign false Require a sign to be at the destination of the teleportation.
mechanics.teleporter.max-range 0 The maximum distance between the start and end of a teleporter. Set to 0 for infinite.

Toggle Area Configuration

Configuration Node and Path Default Value Effect
mechanics.area.enable false Enables Toggle Areas.
mechanics.area.allow-redstone true Allow ToggleAreas to be toggled via redstone.
mechanics.area.use-schematics true Use MCEdit Schematics for saving areas. This allows support of all blocks and chest/sign data.
mechanics.area.shorten-long-names true If this is enabled, namespaces too long to fit on signs will be shortened.
mechanics.area.max-size 5000 Sets the max amount of blocks that a ToggleArea can hold.
mechanics.area.max-per-user 30 Sets the max amount of ToggleAreas that can be within one namespace.

Tree Lopper Configuration

Configuration Node and Path Default Value Effect
mechanics.tree-lopper.enable false Enables the Tree Lopper mechanic.
mechanics.tree-lopper.block-list [LOG, LOG_2] A list of log blocks. This can be modified to include more logs. (for mod support etc)
mechanics.tree-lopper.tool-list [IRON_AXE, WOOD_AXE, STONE_AXE, DIAMOND_AXE, GOLD_AXE] A list of tools that can trigger the TreeLopper mechanic.
mechanics.tree-lopper.max-size 30 The maximum amount of blocks the TreeLopper can break.
mechanics.tree-lopper.allow-diagonals false Allow the TreeLopper to break blocks that are diagonal from each other.
mechanics.tree-lopper.enforce-data false Make sure the blocks broken by TreeLopper all share the same data values.
mechanics.tree-lopper.place-saplings false If enabled, TreeLopper will plant a sapling automatically when a tree is broken.
mechanics.tree-lopper.break-leaves false If enabled, TreeLopper will break leaves connected to the tree. (If enforce-data is enabled, will only break leaves of same type)

XP Storer Configuration

Configuration Node and Path Default Value Effect
mechanics.xp-storer.enable false Enable the XP Storer mechanic.
mechanics.xp-storer.block MOB_SPAWNER The block that is an XP Spawner.
mechanics.xp-storer.require-sneaking-state no Sets how the player must be sneaking in order to use the XP Storer.

Circuit Configuration

Pipe Configuration

Configuration Node and Path Default Value Effect
circuits.pipes.enable false Enables the pipe mechanic.
circuits.pipes.allow-diagonal false Allow pipes to work diagonally. Required for insulators to work.
circuits.pipes.insulator-block WOOL When pipes work diagonally, this block allows the pipe to be insulated to not work diagonally.
circuits.pipes.stack-per-move true This option stops the pipes taking the entire chest on power, and makes it just take a single stack.
circuits.pipes.require-sign false Requires pipes to have a [Pipe] sign connected to them. This is the only way to require permissions to make pipes.


Redstone Pumpkins Configuration

Configuration Node and Path Default Value Effect
circuits.wiring.pumpkins-enabled false Enables the redstone pumpkins mechanic, which toggles pumpkins and Jack O Lanterns depending on power state.

Redstone Netherrack Configuration

Configuration Node and Path Default Value Effect
circuits.wiring.netherrack-enabled false Enables the redstone netherrack mechanic, which lights netherrack when it is powered.

Redstone Glowstone Configuration

Configuration Node and Path Default Value Effect
circuits.wiring.glowstone-enabled false Enables the redstone glowstone mechanic, which toggles glowstone and a configurable block depending on power state.
circuits.wiring.glowstone-off-block GLASS Sets the block that the redstone glowstone mechanic turns into when turned off.

Redstone Jukebox Configuration

Configuration Node and Path Default Value Effect
circuits.jukebox.enable false Enables the redstone jukebox mechanic.

Integrated Circuit (IC) Configuration

Configuration Node and Path Default Value Effect
circuits.ics.enable false Enables IC mechanics.
circuits.ics.cache true Saves many CPU cycles with a VERY small cost to memory (Highly Recommended)
circuits.ics.max-radius 10 The max radius IC's with a radius setting can use. (WILL cause lag at higher values)
circuits.ics.allow-short-hand true Allows the usage of IC Shorthand, which is an easier way to create ICs.
circuits.ics.keep-loaded false Keep any chunk with an ST IC in it loaded.
circuits.ics.disallowed-ics [] A list of IC's which are never loaded. They will not work or show up in /ic list.
circuits.ics.default-coordinate-system RELATIVE The default coordinate system for ICs. This changes the way IC offsets work. From RELATIVE, OFFSET and ABSOLUTE.
circuits.ics.save-persistent-data true Saves extra data to the CraftBook folder that allows some ICs to work better on server restart.
circuits.ics.midi-use-percussion false Plays the MIDI percussion channel when using a MIDI playing IC. Note: This may sound horrible on some songs.
circuits.ics.break-on-error false Break the IC sign when an error occurs from that specific IC.


Language: English  • Fran├žais

Vehicle Configuration

Minecart Configuration

Boat Configuration

Drops Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.drops.enable false Enables the boat drops mechanic.
Exit Remover Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.remove-on-exit.enable false Enables the remove on exit mechanic.
vehicles.boat.remove-on-exit.give-item false Gives the boat item to the player upon exit.
Land Boats Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.land-boats.enable false Enables the Land Boats mechanic.
Remove Entities Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.remove-entities.enable false Enables the remove entities mechanic.
vehicles.boat.remove-entities.remove-other-boats false Allows the mechanic to remove other boats, as well as other entities.
Speed Modifiers Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.speed-modifiers.enable false Enables the speed modifiers mechanic.
vehicles.boat.speed-modifiers.max-speed 0.4 Sets the maximum speed of a boat.
vehicles.boat.speed-modifiers.unnoccupied-deceleration -1 Sets the unnoccupied deceleration of a boat. -1 is disabled.
vehicles.boat.speed-modifiers.occupied-deceleration 0.2 Sets the occupied deceleration of a boat.
Uncrashable Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.uncrashable.enable false Enables the Uncrashable mechanic.
Water Place Only Configuration
Configuration Node and Path Default Value Effect
vehicles.boat.water-place-only.enable false Enables the water place only mechanic.

Configuration Prior to CraftBook 3.5

For configuration prior to 3.5, please see this page.



Namespaces

Variants
Actions