CraftBookConfiguration

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

CraftBook 3.5+

Configuration Node and Path	Default Value	Effect
enable-circuits	true	Whether or not to enable the 'circuits' component of CraftBook.
enable-mechanisms	true	Whether or not to enable the 'mechanisms' component of CraftBook.
enable-vehicles	true	Whether or not to enable the 'vehicles' component of CraftBook.
language	en_US	The default language from the 'languages' list to use.
languages	en_US	A list of available languages to use.
safe-destruction	true	Disallow mechanisms to dupe items.
check-worldguard-flags	false	Whether or not CraftBook will check WorldGuard's use and build flags when checking if users can use the area.
indirect-redstone	false	Allows CraftBook to register redstone interaction when redstone is powered, but not directly facing the IC.
no-op-permissions	false	If true, OP's will not default to recieving all permissions.
use-block-distance	false	Whether or not CraftBook rounds distance equations to the block grid.
notify-updates	true	Whether or not CraftBook will check for updates.
st-think-ticks	2	The amount of game ticks between SelfTriggered mechanic activations. 2 is the same speed as a redstone update. Setting the value to an odd number will cause weird side effects.
advanced-block-checks	false	Similar to WorldGuard checks, but will work for any protection plugin.
use-experimental-clicks	false	Use experimental clicking method to work out clicks which wouldn't normally work.
debug-mode	false	Enables debug mode.
debug-flags		List of debug flags to enable. See here.
easter-eggs	true	Enable few easter eggs placed into the console upon startup.
circuits.ics.enable	true	Enable IC mechanics. See IC's
circuits.ics.cache	true	Cache IC's in memory for short term access. Dramatically lowers CPU usage, with slight gain in memory usage. See IC's
circuits.ics.max-radius	15	Max radius for standard radius/offset IC's. See IC's
circuits.ics.allow-short-hand	true	Enable IC shorthand. See IC's
circuits.ics.keep-loaded	false	Keep IC's loaded even when a chunk unloads. See IC's
circuits.ics.disallowed-ics		List of IC's to be disabled. These IC's can not be used. See IC's
circuits.ics.default-coordinate-system	RELATIVE	Sets the default offset coordinate system. From RELATIVE, OFFSET and ABSOLUTE. See IC's
circuits.wiring.netherrack-enabled	false	Enables redstone netherrack. See Redstone Netherrack
circuits.wiring.pumpkins-enabled	false	Enables redstone pumpkins. See Redstone Pumpkins
circuits.wiring.glowstone-enabled	false	Enables redstone glowstone. See Redstone Glowstone
circuits.wiring.glowstone-off-block	20	Redstone glowstone off block. See Redstone Glowstone
circuits.pipes.enable	true	Enable the pipes mechanic. See Pipes
circuits.pipes.allow-diagonal	false	Allow pipes to pass items diagonally. Also enables insulators. See Pipes
circuits.pipes.insulator-block	35	The block used as an insulator in pipes. See Pipes
circuits.pipes.stack-per-move	true	When enabled, only move 1 stack per pulse. Otherwise move entire inventory contents. See Pipes
circuits.pipes.require-sign	false	Require a [Pipe] sign to be attached to the pipe. Useful to require permissions to build pipes. See Pipes

CraftBook 3.4-

Common configuration

All configurations have these options.

Configuration Node	Default Value	Effect
languages	en_US	List of allowed languages. See Languages
opPerms	true	Sets if it should default to OP for permissions.
use-block-radius	false	Radius calculation algorithm. (I don't know what change this does yet. Will need to check)
check-worldguard-flags	true	Checks WorldGuard flags if someone is allowed to build/use things in the area.

Circuits configuration

Options specific to CraftBook Circuits

Configuration Node	Default Value	Effect
redstone-netherstone	false	Lit/unlit netherrack conversion by redstone. See Redstone netherrack
redstone-pumpkins	true	Pumpkin/Jack o Lantern conversion by redstone. See Redstone pumpkins
redstone-glowstone	false	Glowstone/Glass conversion by redstone. See Redstone glowstone
glowstone-off-material	20	Redstone Glowstone Off Block Material. See Redstone glowstone
redstone-ics	true	Enable redstone Intergrated Circuits. See Integrated circuits

Mechanisms configuration

Options specific to CraftBook Mechanisms

Section	Configuration Node	Default Value	Effect
Mechanisms	stop-mechanism-dupe	true	Stop Gates, Bridges and Doors from duplicating materials.
AI Mechanics	enable	true	Enable AI Mechanics. See AI Mechanics
AI Mechanics	realistic-zombie-vision	true	Enable Zombie AI Mechanics. See AI Mechanics
AI Mechanics	skeleton-critical-shot	true	Allows skeletons to get a every-so-often critical shot. See AI Mechanics
Ammeter	enable	true	Enable ammeter. See Ammeter
Ammeter	id	263	Item ammeter uses. See Ammeter
Chunk Anchor	enable	true	Enable chunk anchors. See Chunk Anchors
Toggle Areas	enable	true	Enable toggle areas. See Toggle areas
Toggle Areas	redstone	true	Enable redstone toggling for toggle areas. See Toggle areas
Toggle Areas	max-areas-per-user	30	Max areas each user can have. See Toggle areas
Toggle Areas	max-size-per-area	5000	Max blocks per area. See Toggle areas
Toggle Areas	use-schematic	true	Use new area format. See Toggle areas
Bookcase	enable	true	Enable readable bookshelves. See Readable bookshelves
Bookcase	read-text	You pick up a book...	Text that readable bookshelves uses. See Readable bookshelves
Bridge	enable	true	Enable bridges. See Bridges
Bridge	redstone	true	Enable bridges via redstone. See Bridges
Bridge	max-length	30	Max length of a bridge. See Bridges
Bridge	max-width	5	Max width either side. 5 = 11, 1 in middle, 5 on either side. See Bridges
Bridge	blocks	4, 5, 20, 43	Blocks bridges can use. See Bridges
Cauldron	legacy-enable	true	Enable legacy cauldrons. See Legacy Cauldron
Cauldron	legacy-block	1	Legacy cauldron block. See Legacy Cauldron
Cauldron	new-enable	true	Enable new cauldrons. See Cauldron
Cauldron	new-spoons	true	Use spoons for new cauldron. See Cauldron
Chairs	enable	true	Enable chair mechanic. See Chairs
Chairs	sneaking	true	Require sneaking to activate chair mechanic. See Chairs
Chairs	blocks	53, 67, 108, 109, 114, 128, 134, 135, 136	Blocks chairs can be used on. See Chairs
Command Sign	enable	true	Enable command signs. See Command Signs
Cooking Pot	enable	true	Enable cooking pots. See Cooking Pots
Cooking Pot	requires-fuel	false	Require fuel to cook. See Cooking Pots
Custom Crafting	enable	true	Enable custom crafting. See Custom Crafting
Custom Drops	enable	true	Enable custom drops. See Drops
Custom Drops	require-permissions	false	Require permissions to get the drops. See Drops
Dispenser Recipes	enable	true	Enable dispenser recipes. See Dispenser Recipes
Door	enable	true	Enable doors. See Doors
Door	redstone	true	Enable doors via redstone. See Doors
Door	max-length	30	Max length of a door. See Doors
Door	max-width	5	Max width either side. 5 = 11, 1 in middle, 5 on either side. See Doors
Door	blocks	4, 5, 20, 43	Blocks doors can use. See Doors
Elevator	enable	true	Enable elevators. See Elevators
Elevator	loop-top-bottom	false	Enable elevator looping. See Elevators
Elevator	allow-button-on-back	true	Allows elevator usage by button on back of sign block. See Elevators
Gate	enable	true	Enable gates. See Gates
Gate	redstone	true	Enable gates via redstone. See Gates
Gate	limit-columns	true	Limit columns in a gate. See Gates
Gate	max-columns	14	Limit columns in a gate to this number if enabled. See Gates
Gate	blocks	85, 101, 102, 113	Blocks gates can use. See Gates
Hidden Switch	enable	true	Enable hidden switches. See Hidden switches
Hidden Switch	any-side	true	Can use any side of the attached block. See Hidden switches
Lightstone	enable	true	Enable lightstone. See LightStone
Lightstone	id	348	Item used by lightstone. See LightStone
Light Switch	enable	true	Enable light switches. See Light switches
Light Switch	max-range	10	Max lightswitch search range. See Light switches
Light Switch	max-lights	20	Max lightswitch lights triggered. See Light switches
Map Changer	enable	true	Enable map changer. See Map Changer
Painting Settings	enable	true	Enable Painting Switcher Mechanic. See Painting Switcher
Snow	piling-enable	true	Enable snow mechanic. See Snow
Snow	trample-enable	true	Allow players to trample snow. See Snow
Snow	placable-snow	true	Allow players to place snowballs, making snow. See Snow
Snow	jump-trample-only	true	Only tramples snow when the player jumps on it. See Snow
Snow	pile-high	false	Snow piling builds up into full snow blocks. See Snow
Teleporter	enable	true	Enable teleporters. See Teleporters
Teleporter	max-range	-1	If greater than 0, teleporters need to be within this range. See Teleporters
Teleporter	need-sign-destination	false	If true, sign needs to be at destination of teleporters. See Teleporters
XP Storer	enable	true	Enable XP Storers. See XP Storer

Vehicles configuration

Options specific to CraftBook Vehicles

Configuration Node	Default Value	Effect
max-boost-block	41	Block for max boost mechanic.
25x-boost-block	14	Block for 25x boost mechanic.
50x-slow-block	88	Block for 50x slow mechanic.
20x-slow-block	13	Block for 20x slow mechanic.
reverse-block	35	Block for reverse mechanic.
station-block	49	Block for station mechanic.
sort-block	87	Block for sort mechanic.
eject-block	42	Block for eject mechanic.
deposit-block	15	Block for deposit mechanic.
teleport-block	133	Block for teleport mechanic.
lift-block	112	Block for minecart elevator mechanic.
dispenser-block	129	Block for dispenser mechanic.
messager-block	121	Block for messager mechanic.
minecart-track-messages	true	Allow minecart messager mechanic.
minecart-enter-on-impact	true	Entity fill minecart upon impact.
minecart-slow-when-empty	true	Slow minecart when empty.
minecart-decay-when-empty	false	Slowly destroy minecart when empty.
minecart-decay-time	20	Time for minecart decay.
minecart-remove-on-exit	false	Destroy minecart on exit.
minecart-remove-entities	false	Minecart kills anything it hits.
minecart-remove-entities-othercarts	false	Minecart breaks other carts it hits.
minecart-max-speed-modifier	1	Max speed multiplier.
boat-remove-entities	false	Boat kills things it hits.
boat-no-crash	false	Stop boat crashing.
boat-remove-entities-otherboats	false	Boat kills other boats when hit.
boat-break-return-boat	false	Boat drops boat when broken.

Permissions

Permission Node	Effect
craftbook.reload	Allows the use of the plugin's reload command. (/cb reload)
craftbook.update	Allows the use of the plugin's update command. (/cb update)
craftbook.mech.area.save.self	Allows the use of the save area command for Toggle Areas.
craftbook.mech.area.save.<namespace>	Allows the use of the save namespace area command for Toggle Areas.
craftbook.mech.area.delete.self	Allows the use of the delete area command for Toggle Areas.
craftbook.mech.area.delete.<namespace>	Allows the use of the delete namespace area command for Toggle Areas.
craftbook.mech.area.delete.<namespace>.all	Allows the use of the delete namespace all area command for Toggle Areas.
craftbook.mech.area.list.self	Allows the use of the list self area command for Toggle Areas.
craftbook.mech.area.list.all	Allows the use of the list all area command for Toggle Areas.
craftbook.mech.area.list.<namespace>	Allows the use of the list namespace area command for Toggle Areas.
craftbook.mech.area.sign.area	Allows the creation of Toggle Areas
craftbook.mech.area.sign.savearea	Allows the creation of Toggle Save Areas
craftbook.mech.area.use	Allows the use of Toggle Areas.
craftbook.mech.ammeter.use	Allows the use of the ammeter
craftbook.mech.pistons.bounce	Allows the creation of Bounce piston mechanics
craftbook.mech.pistons.crush	Allows the creation of Crush piston mechanics
craftbook.mech.pistons.superpush	Allows the creation of SuperPush piston mechanics
craftbook.mech.pistons.supersticky	Allows the creation of Super Sticky piston mechanics
craftbook.mech.bridge	Allows the creation of bridges
craftbook.mech.bridge.use	Allows the use of bridges
craftbook.mech.bridge.restock	Allows the player to restock the bridge.
craftbook.mech.bridge.infinite	Allows the player to set the amount of blocks to infinite.
craftbook.mech.bookshelf.use	Allows the players to read books
craftbook.mech.cauldron	Allows the players to craft in cauldrons
craftbook.mech.cauldron.use	Allows the players to craft in new cauldrons
craftbook.mech.chair.use	Allows the players to sit on chairs.
craftbook.mech.command	Allows the players to create command signs.
craftbook.mech.command.use	Allows the players to use command signs
craftbook.mech.cook	Allows the players to create and use cooking pots.
craftbook.mech.door	Allows the players to create doors
craftbook.mech.door.use	Allows the players to use doors
craftbook.mech.door.infinite	Allows the player to set the amount of blocks to infinite.
craftbook.mech.door.restock	Allows the player to restock the door.
craftbook.mech.drops	Allows the players to collect custom drops.
craftbook.mech.elevator	Allows the players to create and ONLY create elevators.
craftbook.mech.elevator.use	Allows the players to use but not create elevators.( must have both elevator and elevator.use to work properly)
craftbook.mech.gate	Allows the players to create gates
craftbook.mech.dgate	Allows the players to create small gates
craftbook.mech.gate.use	Allows the players to use gates
craftbook.mech.gate.restock	Allows the player to restock the gate.
craftbook.mech.gate.infinite	Allows the player to set the amount of blocks to infinite.
craftbook.mech.hiddenswitch	Allows the players to create and use hidden switches
craftbook.mech.hiddenswitch.use	Allows the players to use hidden switches
craftbook.mech.lightstone.use	Allows the use of the light stone
craftbook.mech.light-switch	Allows the players to create and use light switches
craftbook.mech.map	Allows the players to create map changer mechanic
craftbook.mech.map.use	Allows the players to use map changer mechanic
craftbook.mech.paintingswitch.use	Allows the players to use painting switch mechanic
craftbook.mech.pay	Allows the players to create and use payment mechanics
craftbook.mech.pay.use	Allows the players to use but not create payment mechanics
craftbook.mech.signcopy.use	Allows the player to use the sign copier mechanic.
craftbook.mech.snow.place	Allows the players to place snowballs
craftbook.mech.snow.trample	Allows the players to trample snow
craftbook.mech.teleporter	Allows the players to create and use teleporters
craftbook.mech.teleporter.use	Allows the players to use but not create teleporters
craftbook.mech.xpstore.use	Allows the player to use the XP Storer.
craftbook.vehicles.deposit	Allows the player to create a deposit or collection sign
craftbook.vehicles.dispenser	Allows the player to create a dispenser sign
craftbook.vehicles.ejector	Allows the player to create an ejection sign
craftbook.vehicles.print	Allows the player to create a print sign
craftbook.vehicles.reverser	Allows the player to create a reverse sign
craftbook.vehicles.sorter	Allows the player to create a sort sign
craftbook.vehicles.station	Allows the player to create a station sign
craftbook.vehicles.teleport	Allows the player to create a teleport sign
craftbook.vehicles.cartlift	Allows the player to create a minecart elevator (CartLift) sign
craftbook.circuits.pipes	Allows the players to create pipe signs. Most effective if 'pipes require signs' is enabled in the config.
craftbook.ic.*	Allows the players to create and use ALL integrated circuits. This is not recommended for normal players, only admins/trusted people.
craftbook.ic.<category>.mcxxx	Allows the players to create and use the specified integrated circuit in the category.
craftbook.ic.<category>.*	Allows the players to create and use ALL integrated circuits in the category. This includes safe AND restricted IC's.
craftbook.ic.safe.*	Allows the players to create and use safe integrated circuits. A safe IC is one that can't effect your server and is built for players to use.
craftbook.ic.restricted.*	Allows the players to create and use restricted integrated circuits. Restricted IC's are built for admins to use, and can effect your server.
craftbook.ic.mcxxxx	Allows the players to create and use integrated circuits of the server admins choosing
craftbook.ic.safe.mcxxxx	Allows the players to create and use safe integrated circuits of server admins choosing
craftbook.ic.restricted.mcxxxx	Allows the players to create and use restricted integrated circuits of server admins choosing
craftbook.plc.debug	Allows players to view debug information when right clicking PLC signs.

Block bags

Warning: Configuration information below applies to hMod. It does not yet apply to the Bukkit version of CraftBook!

Block bags determine "sources" and "sinks" for getting and storing blocks. Some features, like Bridges, need to create blocks when it is turned on, and then put away blocks when it needs to turn off. Sources are methods to get blocks, while sinks are methods to store blocks. The default block bag (unlimited-black-hole) will provide an unlimited number of blocks and discard any block stored to it. To thwart block farming, you can change the block bag that you want to use (such as to the nearby-chests one). You can list several different types of block bags to use, but make sure you don't only provide a source or only provide a sink!

Block bag type	Source?	Sink?	Description
unlimited-black-hole	Yes	Yes	Unlimited blocks, discards all given blocks
black-hole	No	Yes	Discards all given blocks
unlimited-block-source	Yes	No	Provides unlimited blocks
admin-black-hole	No	Yes	Eats all given blocks if a [Black Hole] sign (admin-only) is nearby
admin-block-source	Yes	No	Provides unlimited blocks if a [Block Source] sign (admin-only) is nearby
nearby-chests	Yes	Yes	Use nearby chests

Parameter	Value	Default	Description
block-bags	list of accepted values	unlimited-black-hole	Block bags to use, separated by commas.