CraftBook

Logo

CraftBook 4 is in the design phase! Fill out this survey to help us work out what the community wants!

For 1.8 Spigot, see if you wish to support us! Here ($2.50), alternatively Here (Free), which is free.

CraftBook is a heavily customizable plugin that adds a number of new mechanics to Minecraft with no client mods required. As one of Minecraft's oldest mods/plugins, we were the first to bring you Minecraft computers, Redstone ICs, moving bridges, and more! Here's a short list:

  • Modular, and extremely light on your server.
  • Enable features that you need, disable ones that you don't. Even tweak features to your liking.
  • Adds heaps of mechanics that allow you to mimic large portions of FTB/Tekkit with a vanilla client.
  • Redstone ICs (Logic gates, Sensors, Many others)
  • Elevators for your server so people can jump between floors quickly. (Or smoothly, if you choose so)
  • Working cauldrons so players can cook inside them.
  • Your own custom crafting recipes.
  • Hidden switches for players.
  • Togglable areas and bridges.
  • Chairs you can sit on.
  • Working pipes that can transfer items from place to place.
  • Footprints where your players walk.
  • Mobs and players drop their heads.
  • The ability to bind commands to items, with cool-downs, permissions and timers.
  • And much more... (Seriously, check the wiki)

The CraftBook wiki is currently being revamped! Progress can be viewed here! If you find any issues with the wiki (Especially in pages marked 100% of missing), please report them here.

Want to script plugins without knowing Java? Consider CommandHelper. Want to add /homes /warps /tp /bring, etc.? Try CommandBook.

Getting Started

Installation

Bukkit is currently required.

  1. Install WorldEdit first. (DON'T FORGET THIS)
  2. Install any other plugins required for specific features you want.
  3. Download CraftBook and copy the .jar into plugins/.
  4. Run your server once to generate the files.
  5. Edit plugins/CraftBook/config.yml to your liking, and enable anything you want to use.
    Note: For optimal performance, only enable what you need. If you are running a version prior to 3.8.1, check the config to see if any features are enabled that you don't want.
  6. Restart the server for the settings to take effect.

You'll have to read the wiki (see below) to find the permissions you need.

Documentation

For Permissions, Configuration, A list of features and more, check out the wiki

Read the Wiki Chat with Us Report a Bug Source Code

Learning More
  • Project leader: Contact Me4502 on Twitter
  • Lead developers: Me4502, Dark_Arc
  • Project started: On October 22nd 2010 (Bukkit was started January 2011)
  • Use FalseBook? WIP FalseBook to CraftBook Converter: http://dev.bukkit.org/server-mods/unfalsifier/
  • Want CraftBook for singleplayer? Use this mod to allow plugins on SinglePlayer
  • Official Minecraft Server: Come join us at play.fortunemc.net
Quote from metrics:

We use metrics to collect stats! We only collect basic things such as version type, and players online. Visit mcstats.org if you would like to learn more about the stats collected. Go into /plugins/PluginMetrics/config.yml to disable stat collecting if you wish.

Quote from auto updater:

We use an auto updater to check for updates! If you wish to disable it, set update-check: false in the config.yml file.

Testimonials
Quote from testimonials:
  • CraftBook is an amazing plugin helping our users build amazing creative structures all over EcoCityCraft. Highly recommend this to other owners/communities. — andrewkm of EcoCityCraft
  • CraftBook is great, we've used it for more than 3 years and we recommend it to everyone. — sawine of MineTown
Thank You

Thank you to the following individuals and organizations (Any donation of $30 or over qualifies you for this list)

Want to support CraftBook yourself? The best way to thank us for working on CraftBook, is to donate. We greatly appreciate it!

Donate

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Me4502 Me4502 Mar 27, 2015 at 08:02 UTC - 0 likes

    @aberts10: Go

    Please use the version for spigot, it's available at the top of the page.

    @exit151: Go

    The configuration all looks fine.. Does any aspect of them work? Like when making the sign does it give the message?

    https://dl.dropbox.com/u/20806998/CraftBook%20Logo.png BFAK:Me4502,29161,4f0de51cb88cee87b6bde141dc91aad088e966ece17f83fc6225cb872dcbc2c8 Donate Moving from FalseBook to CraftBook?|My website!|Quality server hosting!

  • Avatar of aberts10 aberts10 Mar 26, 2015 at 13:34 UTC - 0 likes

    Problem when starting O_O im using spigot 1.8.3...... 9:31:01 AM [INFO] This server is running CraftBukkit version git-Spigot-c136710-350cb99 (MC: 1.8.3) (Implementing API version 1.8.3-R0.1-SNAPSHOT)..........

    9:31:17 AM [INFO] [CraftBook] Enabling CraftBook v3.9-SNAPSHOT.3895- 9:31:17 AM [SEVERE] Error occurred while enabling CraftBook v3.9-SNAPSHOT.3895- (Is it up to date?) 9:31:17 AM java.lang.NoSuchMethodError: com.google.common.cache.CacheBuilder.maximumSize(I)Lcom/google/common/cache/CacheBuilder; 9:31:17 AM at com.sk89q.craftbook.util.ItemSyntax.<clinit>(ItemSyntax.java:108) [?:?] 9:31:17 AM at com.sk89q.craftbook.bukkit.CraftBookPlugin.onEnable(CraftBookPlugin.java:369) [?:?] 9:31:17 AM at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:321) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:335) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:405) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at org.bukkit.craftbukkit.v1_8_R2.CraftServer.loadPlugin(CraftServer.java:356) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at org.bukkit.craftbukkit.v1_8_R2.CraftServer.enablePlugins(CraftServer.java:316) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at net.minecraft.server.v1_8_R2.MinecraftServer.r(MinecraftServer.java:416) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at net.minecraft.server.v1_8_R2.MinecraftServer.k(MinecraftServer.java:382) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at net.minecraft.server.v1_8_R2.MinecraftServer.a(MinecraftServer.java:337) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at net.minecraft.server.v1_8_R2.DedicatedServer.init(DedicatedServer.java:257) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at net.minecraft.server.v1_8_R2.MinecraftServer.run(MinecraftServer.java:522) [spigot-1.8.3.jar:git-Spigot-c136710-350cb99] 9:31:17 AM at java.lang.Thread.run(Unknown Source) [?:1.8.0_40]

    Last edited Mar 26, 2015 by aberts10

    http://s21.postimg.org/ggx3hwa9f/Aberts10.png

  • Avatar of exit151 exit151 Mar 22, 2015 at 19:42 UTC - 0 likes

    They are both here for better viewing:http://lanfest.dyndns.org/minecraft/craftbook/

    config:

    1. CraftBook Configuration for Bukkit. Generated for version: 3.9-SNAPSHOT
    2. This configuration will automatically add new configuration options for you,
    3. So there is no need to regenerate this configuration unless you need to.
    4. More information about these features are available at...
    5. http://wiki.sk89q.com/wiki/CraftBook/Usage
    6. NOTE! NOTHING IS ENABLED BY DEFAULT! ENABLE FEATURES TO USE THEM!
    1. List of mechanics to enable! If they aren't in this list, the server won't load them! enabled-mechanics: - Variables - Gate - ChunkAnchor - Chairs - Bridge - ICs
    1. A list of CraftBook mechanics that are disabled, for easy copy/pastability to the enabled list. disabled-mechanics: - AI - Ammeter - BetterLeads - BetterPhysics - BetterPistons - BetterPlants - BoatDecay - BoatDrops - BoatExitRemover - BoatRemoveEntities - BoatSpeedModifiers - BoatUncrashable - BoatWaterPlaceOnly - Bookcase - BounceBlocks - Cauldron - CommandItems - CommandSigns - CookingPot - CustomCrafting - CustomDrops - DispenserRecipes - Door - Elevator - Footprints - Glowstone - HeadDrops - HiddenSwitch - 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
    1. WARNING! Changing this can result in all ST mechanics acting very weirdly, only change this if you know what you are doing! st-think-ticks: 2
    1. 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. notify-updates: true
    1. Causes many mechanics to require sufficient blocks to function, for example gates, bridges and doors. safe-destruction: true
    1. If on, OP's will not default to have access to everything. no-op-permissions: false
    1. Allows redstone not directly facing a mechanism to trigger said mechanism. indirect-redstone: false
    1. Rounds all distance equations to the block grid. use-block-distance: false
    1. Checks to see if WorldGuard allows building/using in the area when activating mechanics. check-worldguard-flags: true
    1. 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. advanced-block-checks: true
    1. 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. pedantic-block-checks: false
    1. Make sure a player can only press signs so often. sign-click-timeout: 10
    1. The default language for CraftBook. Note: This language needs to be in the 'languages' field for this to work. language: en_US
    1. A list of languages supported by craftbook, if a user requests a language not listed... They will see default. languages: - en_US
    1. If enabled, CraftBook will scan messages sent to players for localizable text, instead of just checking if the entire message is localizable. scan-text-for-localization: false
    1. Enable a mode that will print extra debug information to the console. debug-mode: false
    1. Enable certain debug types when debug mode is enabled. debug-flags: []
    1. 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) easter-eggs: true
    1. Random numbers are much more random, with a small cost to CPU usage. realistic-randoms: false
    1. Show messages when a player does not have permission to do something. show-permission-messages: true
    1. 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 persistent-storage-type: YAML
    1. 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. convert-names-to-cbids: true
    1. Causes all debug mode output to be logged into a file. This file is reset every startup (And every /cb reload). debug-mode-file-logging: false

    mechanisms:

    1. CraftBook Mechanism Configuration. Generated for version: 3.9-SNAPSHOT
    2. This configuration will automatically add new configuration options for you,
    3. So there is no need to regenerate this configuration unless you need to.
    4. More information about these features are available at...
    5. http://wiki.sk89q.com/wiki/CraftBook/Usage
    6. NOTE! MAKE SURE TO ENABLE FEATURES IN THE config.yml FILE!

    mechanics: AI: vision-enable: - Zombie - PigZombie crit-bow-enable: - Skeleton attack-passive-enable: - Zombie Ammeter: item: COAL BetterLeads: stop-mob-target: false owner-unleash-only: false hitch-persists: false mob-repel: false allowed-mobs: - ZOMBIE - SPIDER BetterPhysics: falling-ladders: true BetterPistons: crushers: true crushers-kill-mobs: false crusher-blacklist: - OBSIDIAN - BEDROCK super-sticky: true super-push: true movement-blacklist: - OBSIDIAN - BEDROCK bounce: true bounce-blacklist: - OBSIDIAN - BEDROCK max-distance: 12 BetterPlants: fern-farming: true BoatExitRemover: give-item: false BoatRemoveEntities: remove-other-boats: false BoatSpeedModifiers: max-speed: 0.4 unnoccupied-deceleration: -1.0 occupied-deceleration: 0.2 Bookcase: read-when-sneaking: 'no' read-when-holding-block: false Bridge: allow-redstone: true max-length: 30 max-width: 5 blocks: - COBBLESTONE - WOOD - GLASS - DOUBLE_STEP - WOOD_DOUBLE_STEP Cauldron: spoons: true enable-redstone: false item-tracking: false require-sign: false Chairs: allow-holding-blocks: false regen-health: true regen-health-amount: 1.0 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 - ACACIA_STAIRS face-correct-direction: true require-sign: false max-distance: 3 max-click-radius: 5 ChunkAnchor: enable-redstone: true check-chunks: true CommandSigns: allow-redstone: true CookingPot: allow-redstone: true require-fuel: true cook-ores: false sign-click-open: true take-buckets: false super-fast-cooking: false CustomDrops: require-permissions: false DispenserRecipes: cannon-enable: true fan-enable: true fire-arrows-enable: true snow-shooter-enable: true xp-shooter-enable: true Door: allow-redstone: true max-length: 30 max-width: 5 blocks: - COBBLESTONE - WOOD - GLASS - DOUBLE_STEP - WOOD_DOUBLE_STEP Elevator: allow-redstone: false redstone-player-search-radius: 3 enable-buttons: true allow-looping: false smooth-movement: false smooth-movement-speed: 0.5 Footprints: blocks: - DIRT - SAND - SNOW - SNOW_BLOCK - ICE Gate: allow-redstone: true limit-columns: true max-columns: 14 blocks: - FENCE - IRON_FENCE - THIN_GLASS - NETHER_FENCE enforce-type: true max-column-height: 12 gate-search-radius: 3 Glowstone: glowstone-off-block: GLASS HeadDrops: drop-mob-heads: true drop-player-heads: true require-player-killed: true drop-head-when-mined: true override-natural-head-drops: false drop-rate: 0.05 looting-rate-modifier: 0.05 show-name-right-click: true drop-rates: {} custom-mob-skins: {} HiddenSwitch: any-side: true ICs: cache: true max-radius: 10.0 allow-short-hand: true keep-loaded: false disallowed-ics: [] default-coordinate-system: RELATIVE save-persistent-data: true midi-use-percussion: false break-on-error: false LegacyCauldron: block: STONE LightStone: item: GLOWSTONE_DUST LightSwitch: max-range: 10 max-lights: 20 MinecartBooster: max-boost-block: GOLD_BLOCK:0 25x-boost-block: GOLD_ORE:0 50x-slow-block: SOUL_SAND:0 20x-slow-block: GRAVEL:0 MinecartConstantSpeed: speed: 0.5 MinecartDecay: time-in-ticks: 20 MinecartDeposit: block: IRON_ORE:0 MinecartDispenser: block: EMERALD_ORE:0 spawn-infront: false check-for-carts: true propel-cart: false MinecartEjector: block: IRON_BLOCK:0 MinecartElevator: block: NETHER_BRICK:0 MinecartExitRemover: give-item: false MinecartFallModifier: vertical-fall-speed: 0.9 horizontal-fall-speed: 1.1 MinecartMaxSpeed: block: COAL_BLOCK:0 MinecartMessenger: block: ENDER_STONE:0 MinecartMoreRails: pressure-plate-intersection: false ladder-vertical-rail: false ladder-vertical-rail-velocity: 0.5 MinecartNoCollide: empty-carts: true full-carts: false MinecartRemoveEntities: remove-other-minecarts: false allow-empty-carts: false MinecartReverser: block: WOOL:0 MinecartSorter: block: NETHERRACK:0 MinecartSpeedModifiers: max-speed: 0.4 off-rail-speed: 0.0 MinecartStation: block: OBSIDIAN:0 MinecartTeleporter: block: EMERALD_BLOCK:0 MinecartVisionSteering: minimum-sensitivity: 3 Pipes: allow-diagonal: false insulator-block: WOOL stack-per-move: true require-sign: false SignCopier: item: INK_SACK:0 Snow: piling: false trample: false partial-trample-only: false jump-trample: false place: false slowdown: false realistic: false high-piling: false max-pile-height: 3 replacable-blocks: - DEAD_BUSH - LONG_GRASS - YELLOW_FLOWER - RED_ROSE - BROWN_MUSHROOM - RED_MUSHROOM - FIRE falldown-animation-speed: 5 freeze-water: false melt-in-sunlight: false partial-melt-only: false Sponge: radius: 5 circular-radius: true require-redstone: false Teleporter: require-sign: false max-range: 0 ToggleArea: allow-redstone: true use-schematics: true shorten-long-names: true max-size: 5000 max-per-user: 30 TreeLopper: block-list: - LOG - LOG_2 tool-list: - IRON_AXE - WOOD_AXE - STONE_AXE - DIAMOND_AXE - GOLD_AXE max-size: 30 allow-diagonals: false enforce-data: false place-saplings: false break-leaves: false Variables: default-to-global: false enable-in-console: false enable-in-player-commands: false enable-in-player-chat: false override-all-text: false XPStorer: require-bottle: false xp-per-bottle: 16 block: MOB_SPAWNER require-sneaking-state: 'no'

    Last edited Mar 22, 2015 by exit151
  • Avatar of Me4502 Me4502 Mar 22, 2015 at 10:40 UTC - 0 likes

    @exit151: Go

    Please paste in both your config and mechanisms files

  • Avatar of exit151 exit151 Mar 22, 2015 at 01:08 UTC - 0 likes

    Checked the config and the items/issues in question are still enabled in the config (Gates and Bridges), but not functioning. :( Was thinking though maybe it's a issue with permissions, perhaps a bug/issue with the perm system regarding the newer UUID system, that could be a possibility, too, though I'd think as admin mine should work regardless? EDIT: perm system had already been updated (put on same day as many other plugins when I updated to 1.8.x), so it's not that :(

    Last edited Mar 22, 2015 by exit151
  • Avatar of Me4502 Me4502 Mar 21, 2015 at 22:39 UTC - 0 likes

    @bshields78: Go

    The repel mobs mechanic is rather buggy due to the part of Bukkit it uses not working correctly, that isn't really avoidable.

    As for the elevators, I've never heard of that permission issue - every server I know of that runs craftbook hasn't had an issue.

    Are you able to use the pex command to verify that the permission is set on a player?

  • Avatar of bshields78 bshields78 Mar 21, 2015 at 20:53 UTC - 0 likes

    So I use craftbook on my 1.7.10 server and am now in the process of upgrading to 1.8.3. I had originally gotten craftbook for the elevators and better leads repelling mobs but neither of these worked on 1.7.10 spigot, at least not on my server and not on many others as i had read. I better leads was throwing all kinds of entity targeting errors and i read that the elevators perms were broken. only OP's could use it but any normal player with the perms could not. So here i am updating my server to 1.8.3 spigot with hopes that both these issues had been resolved only to find that neither have not. Leads dont repel mobs not even for OP's and elevators only work for OP's not for people with the craftbook.mech.elevator.use perm. on the 1.7.10 server i used essentials group manager, now i am using PEX. My console has absolutely no errors on startup.

  • Avatar of exit151 exit151 Mar 21, 2015 at 17:00 UTC - 0 likes

    Will check and reverify today - They were correct before the update, not sure if the update would have overwritten the config file? Will post a followup..

  • Avatar of Me4502 Me4502 Mar 21, 2015 at 01:13 UTC - 0 likes

    @exit151: Go

    Are the mechanics correctly enabled in the config?

  • Avatar of exit151 exit151 Mar 20, 2015 at 19:14 UTC - 0 likes

    Hey :) First off as always, thanks for the hard work coding this plugin. To anyone who can answer: I'm running the cb 1.8 (spigot) and the latest free version (3.9) of this plugin. It is on a server that has been running since the 1.7.9 era, and just updated 2 weeks ago with the release of a few needed plugins to keep it the way it is. Everything seems great except two minor things, both with this plugin: Bridges and Gates no longer work. I'm wondering if this is a local issue on my server only, or if everyone is having a problem with them? If it's just me, how can I troubleshoot/diagnose the problem? No errors throw on screen or in the console of the server. Thanks!

What is the hardest or most confusing feature of CraftBook to use or setup with help from the wiki? (Please explain reasoning in comments)

  1. Choice:

  1. Results
  2. 31 comments

Facts

Date created
Aug 25, 2011
Categories
Last update
Aug 15, 2014
Development stage
Mature
Language
  • enUS
License
GNU General Public License version 3 (GPLv3)
Curse link
CraftBook
Downloads
581,984
Recent files

Authors

Relationships

Required dependency
WorldEdit
Optional dependency
ProtocolLib
Vault
WorldGuard