BookManager
I No Longer Work On This Plugin
Find it's replacement here: http:dev.bukkit.org/server-mods/bookmanager-reloaded/
Have you written a book with the new book and quill, and realized that you needed to edit something after you signed it? This plugin is for you. If you need to edit the body of the book, you can unsign the book so that you can edit it and sign it again. Just need to rename it? There's also a one-command method in this plugin that allows you to rename books. You can copy a book, and you can require players to use up the materials that make a book and quill. You can also change the author of a book (want a book written by Herobrine or Notch?) and save books as .txt files on the server. Permissions is supported, and this plugin uses separate permissions for editing your own books vs other people's books.
Setup
Very simple. All you need to do is put the jar in your plugins folder. That's it :)
Commands
There are eight commands in this plugin:
- /unsign
- Unsigns the book that you are holding (the highlighted item in your hot bar)
- /rnbook <name>
- Renames the book that you are holding
- /rnauth <name>
- Changes the author name for the book that you are holding. Note: this changes ownership, so if you take a book from someone who can't edit other people's books and you change the author name, that player cannot edit that book anymore.
- /copybook [amount]
- Copies the held written book, taking away a book, ink sack, and a feather (unless they either have the "free" permission or are in Creative mode). You don't need to specify an amount when using this command if you only want one copy.
- /savebook <save name>
- Saves a book as .txt files. Each page is a numbered .txt file inside a folder by the name of the book. Saved books can be found in the folder plugins/BookManager. Also found in the folder is a file called conf.yml. See below for details.
- /loadbook <save name>
- Takes a saved (or edited or new) book from the plugin folder and turns it into a book in-game.
- /deletebook <save name>
- Deletes a saved book in the plugins folder
- /listbooks
- Lists all the books saved in the plugins folder
Saved Books
When you save a book, it makes a folder who's name is whatever you set the save's name to be. The folder can be found in your plugins/BookManager folder. Inside that folder should be a bunch of numbered .txt files. Each one represents a page in the book. You can edit these files directly if you want. Note: there is no error-detection for when you make a page too long. I actually don't know what will happen if you make the pages too long (most likely either cutting it off or a graphical error), so be careful how long you make the files.
In the folder is also a file called conf.yml. This is the configuration file in YAML format for the book. The settings are as follows:
- title
- The title of the book
- author
- The author name of the book
- available
- Whether or not the book is avaiable to everybody with bookmanager.loadbook permission
- free
- Whether or not players need to use up the materials for a book and quill to get the book
Permissions
There are eight main nodes (one for each command):
- bookmanager.unsign
- allows players to unsign their own books (defaults to everybody)
- bookmanager.rnbook
- allows players to rename their own books (defaults to everybody)
- bookmanager.rnauth
- allows players to change the author of books (defaults to OPs only)
- bookmanager.copy
- allows players to copy a book (defaults to everybody)
- bookmanager.savebook
- allows players to save book as .txt files on the server (defaults to OPs only)
- bookmanager.loadbook
- allows players to get books saved in the plugin folder as written books (defaults to everybody)
- bookmanager.deletebook
- allows players to delete saved books in the plugin folder (defaults OPs only)
- bookmanager.listbooks
- allows players to list all the saved books they have access to (defaults to everybody)
There are five sub nodes, all defaulting to OPs only:
- bookmanager.unsign.other
- allows players to unsign other player's books
- bookmanager.rnbook.other
- allows players to rename other player's books
- bookmanager.copy.free
- allows players to copy a book without using any materials
- bookmanager.loadbook.all
- allows players to access all saved books
- bookmanager.laodbook.free
- allows players to load books without using any materials
If you give a player one of these nodes, you don't need to give them the respective main node (for example, if a player has "bookmanager.unsign.other", that player does not need to be given the permission "bookmanager.unsign")
There are also three general permissions (for easier permissions control for admins):
- bookmanager.none
- removes all permissions from player for this plugin
- bookmanager.default
- allows player to edit their own books and make copies from materials
- bookmanager.admin
- allows player to edit any book and make copies for free
It would be good if the spaces are allowed in the name of saving.
@alexandercitt If you look at the source:
You see the permissions are: bookmanager.loadtxt.free
Is it normal for a config to not generate?
I've got the same problem as DrBreadgun.
My conf.yml from my book is:
And my permissions are:
(even with your typo)
But still, only OP's can do /load (for free?).
Just got the plugin, and aside from not being able to use /savebook, /loadbook as op, no issues at all.
Great plugin for servers with complex rules/wanting a manual for their players.
Oh my gosh, thank you! This plugin will save lives one day. It's exactly what i was looking for and works perfectly. You're awesome!
Could you have a feature so when people do /rule if gives them a savedbook?
Thanks, great plugin!
@LRFLEW
Nope, players can still copy more books than they have materials for in 0.3
@xcanner
For the first issue, try ALSO giving the players Positive bookmanager.copy (I'm not sure how child permissions work with negative permissions, so I would try this first)
For the second issue, I'm pretty sure I fixed it in the latest version. I'll take a look at it again, but I'm pretty sure I fixed it :P
@DrBreadgun
I wouldn't recommend giving everybody bookmanager.loadbook.all because that's intended for admins only. Instead, try finding the file plugins/BookManager/guide/conf.yml on the server and changing (or adding) the following line:
available: true
If you also want players to get the book without consuming materials, change/add this line too:
free: true
Hello, I like your plugin, It's nice, neat, and nifty, but one slight problem. For my PvP legit server. (Not building), I want regular players to do /loadbook guide. I tried to put the permission node (- bookmanager.loadbook.all) but nothing works!
here's what i have in permissions:
- -bookmanager.unsign - -bookmanager.rnbook - -bookmanager.copy - -bookmanager.savebook - bookmanager.loadbook.all - bookmanager.loadbook - -bookmanager.listbooks
We do not spawn items on my server at all, so i gave the admin group (which consist of 2 players, the 2 players are also OP) a negative copy free permission "-bookmanager.copy.free"
But now the 2 players cant copy books at all (it says "you dont have permission to copy books).
Also if a "normal player" have 3 books, fethers and ink, it is possible to use /copybook 10 and get 10 books.
@Jekotia
Try v0.3 and tell me if it fixes the issue. I made a major code change there that i think was causing the problem.
@lol768
as OP? That shouldn't be an issue. I have noticed some permission issues even when I was OP, but it was fixed by restarting the server. That makes me think it's not my plugin, but a bug in the latest recommended build of bukkit. I don't know, but we will soon when the recommended build for 1.3.2 comes out :)
@LRFLEW
I created and signed the books for the sole purpose of testing the plugin. I do NOT have the nodes for editing others books, because I am testing the ability to edit the players own books.
Very light and very useful, thanks!
@Zamadaga
Same issue. As op I can't use the commands.
Copying is not working at all. it make many books in inv, but after manipulation like drop or putting in dispenser they disappear.
@Zamadaga
The first issue has been confirmed, and will be fixed in the next update. I just noticed the fantom book issue, but I don't know what's causing it. Thanks for letting me know, though :)
EDIT: I think I found it. I'll be experimenting to make sure I did it right, though
@YotsugiOnonoki
Your comment confuses me. If you aren't using a permissions plugin, the permissions will default as stated above. If that's fine with you, you don't need to get one. If you wish to change people's permissions from what's stated above, you need a permissions plugin.
@DomCraft
oh *facepalm*
I forgot the first rule of Java programing: use Object.equals(Object) :P
It will be fixed in v0.3 :)
This seems to always be true. Players with the bookmanager.unsign permission can't unsign their own books, even if tc.getString("author") matches their name.
Players with bookmanager.unsign.other can always unsign books.
P.S. This plugin is great otherwise. Thanks.