Configuration

CraftBook has multiple configuration files, therefore this page will focus on the main one, rather than configuration files for each individual mechanic. To configure mechanics, see Mechanics Usage.

Configuration

Node	Comment	Default
enabled-mechanics	List of mechanics to enable! If they aren’t in this list, the server won’t load them!	[Variables]
disabled-mechanics	A list of CraftBook mechanics that are disabled, for easy copy/pastability to the enabled list.	[AI, Ammeter, BetterLeads, BetterPhysics, BetterPistons, BetterPlants, BoatDecay, BoatDrops, BoatExitRemover, BoatRemoveEntities, BoatSpeedModifiers, BoatUncrashable, BoatWaterPlaceOnly, Bookcase, BounceBlocks, Bridge, Cauldron, Chairs, ChunkAnchor, CommandItems, CommandSigns, CookingPot, CustomCrafting, CustomDrops, DispenserRecipes, Door, Elevator, Footprints, Gate, Glowstone, HeadDrops, HiddenSwitch, ICs, JackOLantern, Jukebox, LandBoats, LegacyCauldron, LegacyCustomDrops, LightStone, LightSwitch, MapChanger, Marquee, MinecartBooster, MinecartCollisionEntry, MinecartConstantSpeed, MinecartDecay, MinecartDeposit, MinecartDispenser, MinecartEjector, MinecartElevator, MinecartEmptySlowdown, MinecartExitRemover, MinecartFallModifier, MinecartItemPickup, MinecartMaxSpeed, MinecartMessenger, MinecartMobBlocker, MinecartMoreRails, MinecartNoCollide, MinecartPlaceAnywhere, MinecartRailPlacer, MinecartRemoveEntities, MinecartReverser, MinecartSorter, MinecartSpeedModifiers, MinecartStation, MinecartTeleporter, MinecartTemporaryCart, MinecartVisionSteering, Netherrack, PaintingSwitcher, Pay, Pipes, SignCopier, Snow, Sponge, Teleporter, ToggleArea, TreeLopper, XPStorer]
st-think-ticks	WARNING! Changing this can result in all ST mechanics acting very weirdly, only change this if you know what you are doing!	2
safe-destruction	Causes many mechanics to require sufficient blocks to function, for example gates, bridges and doors.	true
no-op-permissions	If on, OP’s will not default to have access to everything.	false
indirect-redstone	Allows redstone not directly facing a mechanism to trigger said mechanism.	false
use-block-distance	Rounds all distance equations to the block grid.	false
check-worldguard-flags	Checks to see if WorldGuard allows building/using in the area when activating mechanics.	true
advanced-block-checks	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.	true
pedantic-block-checks	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.	false
sign-click-timeout	Make sure a player can only press signs so often.	10
language	The default language for CraftBook. Note: This language needs to be in the ‘languages’ field for this to work.	en_US
languages	A list of languages supported by craftbook, if a user requests a language not listed… They will see default.	[en_US]
scan-text-for-localization	If enabled, CraftBook will scan messages sent to players for localizable text, instead of just checking if the entire message is localizable.	false
debug-mode	Enable a mode that will print extra debug information to the console.	false
debug-mode-file-logging	Causes all debug mode output to be logged into a file. This file is reset every startup (And every /cb reload).	false
debug-flags	Enable certain debug types when debug mode is enabled.	[]
easter-eggs	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)	true
realistic-randoms	Random numbers are much more random, with a small cost to CPU usage.	false
show-permission-messages	Show messages when a player does not have permission to do something.	true
persistent-storage-type	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, SQLite	YAML
convert-names-to-cbids	Causes mechanics to attempt to convert names to use CBIDs. This can and should be disabled after you believe your servers transition to UUIDs v Names is complete.	true