BookWorm
This is a plugin that lets you read and write books. There are other similar plugins available, but this one is a bit different. This plugin lets you read and write to the actual book items, rather than just affecting bookshelf blocks. The books' text will actually be stored with the book item. In order for this to work, I have made it so books are not stackable.
Minecraft Built-In Written Books
Since Minecraft version 1.3, written books have been built into the game. They have a nice GUI and work well enough for most players and servers. This plugin was created long before that. It is still available and maintained mostly for those servers who still want to keep their old books intact, and for a few who prefer this version over the official books.
I will most likely continue to support this plugin as long as there are those who still use it, but I will not be adding any new features. Any new releases will simply be bug fix updates.
If you are looking for a plugin that enhances the functionality of Minecraft's built-in books, there are many plugins available. Here is just a small selection:
- SwissBook - Adds several features, such as editing already written books and creating a server manual
- BookShelf - Allows placing books in bookshelves
- BookRules - Create a rule book
- BookShop - Allows players to publish and sell their books
Links
Installation and Configuration
Simply copy the jar file into your plugins folder and run your server. Optionally, you can also install the Spout plugin. Adding Spout will allow SpoutCraft users to see book titles on the book tooltip and read books in a GUI instead of in the chat area. Spout is not required for this plugin to work.
View the Configuration page for information about the various options in the config.yml file. View the Permissions page to see the permission nodes this plugin has available.
Usage Statistics
This plugin uses a system to keep track of its usage statistics. This is the same system used by other plugins such as LWC and Vault. Every half hour it "calls home" and reports some basic usage information, like how many players are online, how many pages have been read, and how many lines have been written. You can see the graphs here:
http://metrics.griefcraft.com/plugin/BookWorm
If you would like to opt out, you can do so by setting the enable-usage-stat-collection option to false in the config file.
Usage
This plugin uses the /bookworm command, but it has the /bw and /write commands as aliases. The in-game help is designed to be, well, helpful. Using the command without any arguments will give you context-sensitive help.
To start writing a book, you hold a book in your hand and type /write <title>. You can then use /write <text> to add text to your book. If chat mode is enabled, you can also just chat without using the command to write into the book, as long as you're holding the book. You can use a double-colon :: to create a paragraph. As you write, the plugin will break your text into pages for you.
You can place a book in a bookshelf by left-clicking on the bookshelf with your book in hand. You can get a copy of a book from a bookshelf with left-click, and you can remove a book from a bookshelf with shift-left-click.
When creating a copy of a book, by default the plugin creates a "fake" copy. Any changes made to the original will also show up in the copy, and any changes made to the copy will show up in the original. This includes adding new text, changing the title, erasing text, or any other modification. You can change this behavior by setting the make-real-copy option in the configuration file to true. If you choose to do this, you should be aware that each copy will then take up hard drive space, and "book space". There is a current limit of about 32,000 books.
You can read a book by holding it and right-clicking the air. You can read a book in a bookshelf by right-clicking the bookshelf.
There are some special commands available while writing a book.
- /write -help : shows this list of commands
- /write -chat : toggle chat write mode
- /write -read <page> : read the specified page
- /write -author <author: sets the displayed author (this is just the displayed author, the real author will stay the same)
- /write -title <new title> : change a book's title
- /write -undo : Undo your last write action. Only has one level of undo. Things that can be undone: written text, replacements, erasings.
- /write -erase <text> : erases the specified text from the book
- /write -replace <old text> -> <new text> : replaces text
- /write -eraseall : erases all text from the book
- /write -get <id> : gets the book with the given id
- /write -id : gets the id of the currently held book
- /write -delete <id> : completely deletes the book with the specified id
Videos
My original (somewhat outdated) tutorial video:
A review by zSistine:
Recent Changes
You can view the full change log here.
@nisovin
Please release a smaller 1.11 with the right files in it. :)
color change lightgreen to darkblue it's very hard now to read which book i read or i'm holding
it's possible to go back to lightgreencolor!?
Your the best plugin maker
@Endimmion
It seems I accidentally put some extra files in the jar. The plugin itself is about the same size.
Just by curiosity, what make the huge difference in file size between 1.9 and 1.10?
1.9 was 80kb and now the 1.10 is more than 200kb
Links in the page for Configuration and Permissions are invalid links.
@jamiedigweed
I'm not going to put in extra work to support specific permissions plugins. If they're created correctly, they should all work. I shouldn't have to take the time to fix someone else's plugin.
Any chance of getting this plugin to support groupmanager having alot of issues with the perms not actually working.
Thanks :D And aweomse job :)
hello can i ask will bookworm contradict with craftbook's bookshelf thingy?
@Bowarrow51
Read the usage section?
Is there a command list for this because I can't reload or do any of that
@Trobsky
That's how you remove books. It can't do both.
@drakcore
Editing the files in the BookWorm plugin folder is the only way. How else would you expect to do this?
Is it possible to create books outside of the game "text editor" and some how manage to get it onto a user.
*Creating a library almost mirroring in a simplistic way of the minecraft wiki such as blocks/items/ids/mobs/how to/commands.
Could make empty books within the game then edit them in the Bookworm plugin folder but this is time consuming.
**have set the plugin to create "real" copies.
Very good plugin. My problem is; that its TOO easy to copy a book. Want a leftshift+leftbutton for copy instead. Can you fix that?
You know how one of the command beginnings is /bw? The plug in Button warp uses that.
@Qx2
Ahh yeah sure, here ya go. It's also nice in that when you stop reading and put the book away, next time you pick it up it opens to the page you were on.
This is just a fanfic I converted the format within text editor and dropped the file into the mod. http://s299.photobucket.com/albums/mm319/roninwarrior_elite/?action=view¤t=2012-01-06_025813.png
Does anyone know if there's a place online for us to swap book .txt's around? I've got a massive dome shaped library on my server and I'd love to expand my collection a bit and share a few of the books in it already.
@madcatandrew
And could you put some screenshots?
@Qx2
I too would love screen shots of the Spout GUI.
[Edit]
I actually just installed it on my server to test, and the GUI is nice. I'll definitely be using this long-term on my server, and I can see a market for book trading between our server's nations in the near future...
One thing I would love to see with the spout craft GUI is maybe a paper-like background image for the pages. Something that looks like the base map item without any text and stretched vertically maybe, but I don't know if that's possible or not.
You can add some screenshots? The most curious to me how it looks from the Spout.