BookSuite
BookSuite was originally designed to offer players vanilla-style mechanics to make up for the lack of book-related features. The focus has since shifted towards command-based book alterations.
Functions
- Right click a "printing press" with a written book to copy!
- A printing press is a crafting table with inverted stairs above it.
- For easy press creation, sneak and place stairs on top of a crafting bench!
- Original: PrintingPress - The dev went inactive and didn't supply his source. Rewrote from scratch for 1.4.6.
- Default:
- Ops: Do not need supplies.
- Players: Copy anyone's book, uses supplies. (Supplies are ink and a normal book)
- Cauldron as "eraser" block
- Default: Everyone can unsign own books at cost of water, ops can unsign anyone's books for free
- Usage: Right click cauldron with written book
- Aliases
- Automatically sign books with your display name! Supports team prefix and suffixes as well.
- Can be disabled in the config (enable-aliases: false)
- Colored title and author
- related permission for &codes in normally signed books' titles: booksuite.sign.color
- /book
- Default: everyone
- Aliases: booksuite, bsuite, bs
- Help will display based on permissions - if a user does not have permission to use a command, it will not run or appear, and the help will be displayed instead of a denial of permission message.
Option and Usage |
Description |
Permission | Default |
---|---|---|---|
addpage <number> (optional text) | While holding a Book and Quill, adds a page with your text (if any) at specified number | booksuite.command.edit | everyone |
delpage <number> | While holding a Book and Quill, removes specified page | booksuite.command.edit | everyone |
u(nsign) | Unsign book in hand | booksuite.command.unsign + booksuite.command.unsign.other | op |
a(uthor) <new author> | Set author of book in hand to <new author>, supports spaces. | booksuite.command.author | op |
t(itle) <new title> | Set title of book in hand to <new title>, supports spaces. | booksuite.command.title + booksuite.command.title.other | op |
copy <quantity> | Copy book in hand <quantity> times, default 1. Exactly the same permissions as using a press except for the command permission. | booksuite.command.copy | op |
e(xport)| s(ave) <filename> |
Save books to file. If player can delete books and a book by that name already exists, the player is given 10 seconds to use /book overwrite to save anyway. | booksuite.command.export | everyone |
f(ile)| l(oad)| u(rl) <filename| url> |
Import a book from plaintext. Supports formatting with BML. To import a book from url, make a paste of a flat text file. Use "/book u http://dev.bukkit.org/paste/gy7ekjupawivnbxq.txt" to import the example book. | booksuite.command.import + booksuite.command.import.other | everyone, op to import other |
give | Import a saved book for another player. | booksuite.command.give | everyone |
d(elete) <filename> | Delete a saved book | booksuite.command.delete | op |
l(ist) | List all files in /BookSuite/SavedBooks/ | booksuite.command.list | everyone |
reload | Reload the plugin | booksuite.command.reload | op |
update | Check for updates | booksuite.command.update | op |
Configuration
Please refer to the default config.
Permissions
Permissions page. Copy-friendly permissions page!
Source
Idea Credits
ShinyQuagsire - the original PrintingPress (now inactive)
jkcclemens - /book delete
Novantis - cauldrons instead of sponges as eraser blocks
Iseeicy - addpage
Recommended
BookShelf by Pew446 - Completely revolutionizes using books, wonderful dev. A must.
The Library Project by jkcclemens - a book lover's dream! Scores of books for download and a server for writers.
@ursak
It's all based on the API, it should work decently well without any updates. As far as breakages go, purpur stairs will become normal steps when used in a press, but they should revert to the correct stair material. To be honest, I don't even remember adding support for red sandstone stairs, so I should probably revisit that anyway. In the 1.9 announcement md_5 said that Player#getItemInHand will still be present, though deprecated, and will return Player#getItemInMainHand. That means all the in-world components will still function, ideally. There's still no word on a book generation API, so unfortunately all copies made with the plugin will continue to be the same as whatever they are copied from (original, copy, copy of copy, etc.) until that is written.
I actually did upload a new release today, but I believe the Curse staff has already finished approving files for the day.
@Jikoo_K
Since Minecraft 1.9 is close to being released, does this mean that you plan to update this for 1.9 as quickly as possible? (when it's out and have working bukkit/spigot of course)
I know I said I'd be updating back in February, but I hit some snags, got busy, and forgot. I'm still here, still alive, and actually (somewhat) back. While I don't plan on adding more new features any more, I will be cleaning up the code and fixing all the things I broke the last time I touched it. You can see my progress over on the GitHub.
When 4.0.0 is done, this project will be complete. I'll update it when needed, but I'll no longer be accepting feature requests.
Progress update 11/19:
I think I may have a release-ready version. I need to test it more, but I've cleaned up the code to the best of my abilities.
@Melonking
Very cool! I'll add that to my recommended section if you don't mind.
I made this lil script for myself. It splits blocks of text into pages to be pasted into books, figured id share. http:nonit.me/tools/pagesplit.php
A general announcement: With 1.8, written books will be copiable in vanilla.
My vision for BookSuite was originally to offer players vanilla-style mechanics to make up for the lack of book-related features, however, it's become more and more apparent that the majority of users only are interested in the admin functions
--
command based book alterations. This policy change will be reflected in any version released whenever 1.8 is actually available.The one feature I do plan on removing is book stacking - in 1.8, copied books can be stacked. As it is, stacking requires several very costly checks that can cause severe lag for large copy operations.
I apologize for my lack of updates, I'm afraid that the combination of classes, a side project with a friend, and the enormity of my planned changes have had me overwhelmed.
I hope to have a release out within the next month, but I can make no guarantees.
Thank you for bearing with me.
Edit: Tl;dr: with 1.8 I will be changing the focus of this project towards admin commands.
More edit: It's been a month, and a lot of progress has been made! I'll have a release as soon as I finally manage to work out faking an author properly on at Book and Quill.
@Camaroz1
I've been planning on it, but it does come with a few difficulties, the largest being that rules change - I would have to keep a backlog of old rulebooks to check against. Beyond that, it's not bad; it shouldn't be hard to stop dropping/selling to villagers/placing in chests. I also wanted multiple rulebook support because short books are far more likely to be read.
Could you make a feature give player rules book on first join, respawn, restrict drop?
@JacobCZ
My guess would be the lack of newlines after page denotations in the text file generated. When I tried it before, it made a page
when it actually has to be
I have a little Minecraft Book WYSIWYG info, it is totally broken now, and i dont know why, so it won't work properly untill i fix it...
@Jikoo_K
I thought automatic line breaking in the editor, because if you type more than 22 characters, it just enlarges the line, but i want to break it after 22 chars. I will add page support soon ;)
@JacobCZ
Line breaking as in putting line breaks in before and after <page> and </page>? It does need that, all pages will be blank otherwise >.< I've been debating changing it, but currently if a line contains <page> the following lines start to be added to the page string. </page> causes the page string to be saved, then wipes it in preparation for another <page>. Any text on the same line as a <page> or </page> is ignored.
@JacobCZ
And just addition => i updated the web, it now has more minecraft-like colors, and all should work well, just have to fix a line-breaking, it doesn't work well :D
@Jikoo_K
Yeah, i really love that BML, it is much easier to handle with PHP than YAML (i donť know if it is even possible :D) just please continue doing this plugin :)
@JacobCZ
Added a line about it being indev, look good? Tmathmeyer's the one responsible for the initial importing and BML (Book Markup Language, totally stealing that abbreviation from jkcclemens) and I do most everything else :p It was thiiiis close to being just another plugin that saves in yaml
@tmathmeyer
Okay, I'm verry happy that you like it :) So just PM me your skype or email, and send me some banner ;) And please, add this to the link to my page: "This is totally not a final version, I will add more features and fix lot of bugs ;)" thx.
@JacobCZ
Hey, I'm the guy who made the spec for the books, and you have no idea how happy your doing this has made me :D :D :D maybe some sort of partnership? link back and forth?
@Jikoo_K
Thanks ;) I will try to fix all the bugs and maybe I will ask for donation from users of it (if any xD) and put it on standalone domain (bookwysiwyg.com maybe? :D ), just be patient i make it in my free time and i made the first version in only 3 hours so... :D
@JacobCZ
That looks really cool, quite handy :o
Hi, I wondered about an WYSIWYG editor for this plugin, and because i didn't find any, I created one myself! It is both WYSIWYG editor and hosting service - you just edit your book and then hit the Save button, it will generate a TXT file with name based on md5 hashes of book and author name. You can use the /book u address to fetch that txt to a book in minecraft!
Just one warning - it is pre-alpha, so it cointain lot of bugs, few random things even don't work, so please be patient, i will fix everything...
You can find it here http://book.mineland.cz/
Thanks for reading :)