Pages

Configuration

The plugin configuration options are located in the config.yml file within the BookWorm folder. The configuration allows you to change all the strings used in the plugin, as well as a few other options.

  • show-title-on-held-change: If this is true, a books title will be sent as a message when a player scrolls through books in their hot bar.
  • require-book-to-copy: If this is true, a player will need to be holding an empty book in their hand to copy a book from a bookshelf.
  • make-real-copy: If this is true, a "real" copy of the book will be created when it is copied from a bookshelf. If this is false, a "fake" copy will be created, meaning that any changes to the copy will be reflected in the original (there's only ever one version of the book).
  • auto-chat-mode: If this is true, "chat mode" will be enabled when starting a new book. Chat mode allows a player to write by chatting without using the command.
  • use-full-filenames: If this is true, the book's title and author will be included in the file name. If it is false, it will only contain the book id number.
  • use-spout-features: Whether to enable Spout features, like book tooltips and the reading GUI. If Spout is not enabled on the server, this option will be ignored.
  • use-deny-perms: If this is true, you can use the special deny permission nodes to set up permissions for specific books. Note that if you have this on and you use the '*' node that some permission plugins provide, you will also be given these deny permission nodes.
  • check-worldguard: If this is true, the plugin will only allow a player to place a book in a bookshelf if they have build rights in that location.
  • clean-interval: The plugin will occasionally remove any unused loaded books from memory to keep memory usage down. Leaving this and remove-delay at the default should work for pretty much everyone.
  • line-length: The length, in characters, of each line before it wraps to the next line. The default should work fine for pretty much everyone.
  • page-length: The number of lines per page. A value between 5 and 10 will work best.
  • indent-size: The number of spaces to indent a paragraph. Somewhere between 3 and 6 is probably best.