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
This plugin really needs to be fixed/updated.
It would be neat if people uploaded their own books somewhere.
add the command / loadbook
In the function or procedure
parameter to define a PLAYER to deliver a book
eg
/ loadbook [playername]
By default loadbook works for the player who executes the command
but can be sent to another player if the parameter is filled
eg
/ loadbook LRFLEW
player, LRFLEW receive the book.
or create command / givebook [playername]
and allow this command can be run from console
------
and add permission
bookmanager.loadbook.id or bookmanager.loadbook.xxx
to allow only a certain book can be loaded.
from player with this permission
this is my suggestion
Can you edit the book in a text editor, and add formatting codes?
edit
Looks like I can, but it won't let me unsign a book, even with the permissions and OP
edit
Is there a way to give a book to new players? I was thinking they had unique ID's that could be used with essentials kits.
I have a problem like "lolygagger101", it asks for permission when I am the OP, even the console gets no permission. The only function that works is the "unsign" one. Can you please fix this up?
We have a problem. When we try to save a book, it says that you dont have permission to use that command, we are OP's to, but it won't work :(
Hello, this is an awesome plugin, but I often have problems with loading books from the config file. If I do not do a proper restart on my server after saving the config file, I will get issues. For example, if I try to reload the server, the plugin will start telling me I don't have permission to load books, etc. So it would be awesome if you could implement a command that reloads the config files and all :D
So, with this plugin, not only I can re-do my book because I made a mistake, but I can also rename the author when I finish it, so instead of my name, it can be "Anonymous" or anything else, like Lovecraft and so on?
Great, this the plugin for me! I will try it out and check it out.
I just wish Singleplayer had something identical, maybe it already does.
@SiDzej
I'm actually interested in seeing that, I'll see what I can come up with. Whether LRFLEW would like to accept the pull request or not would be up to him, but for my own use I'd like to see this.
edit: Pull request has been sent. https://github.com/LRFLEW/BookManager/pull/4
Main class in plugin.yml has been corrected in the above commit as well.
edit 2: It has been merged. :)
@SiDzej
Yes. If you will add this feature, SiDzej and me and technically everyone will be happy. So i please you too, make it... ;)
I really miss something like this:
bookmanager.copy allows players to copy their own books
bookmanager.copy.other allows players to copy other player's books
We want to make shops with books...but if anyone can copy any book it will be for nothing :(
error in bookmanager.laodbook.free, isnt suppose to be bookmanager.loadbook.free
Sent another pull request in case you didn't see it LRFLEW. https://github.com/LRFLEW/BookManager/pull/3
A pretty small mistake, but I didn't see it corrected so I figured I might as well send a PR so you can fix it with the click of a button.
Could there please be a way to add bookmanager.loadbook.all to players? Adding the node does nothing and it's not feasible for me to go in and change everyones books to available...
Maybe add a command to set the book as available?
@Rat_Cat12
I'm working on it. I'm doing some last minute bug testing and code changes, and I don't have a lot of time because school is picking back up. I will post an update soon, though :).
@ProjectInfinity
I wasn't really replying to you. I was trying to quote you and speak to the author.
Because that is not up to me.
@ProjectInfinity
Why don't we have an update?
I posted a pull request on Github that fixes the book duplication issue with /copybook. https://github.com/LRFLEW/BookManager/pull/2
Edit: It's been merged. :)
Bug: config doesn't generate on 0.3v and Bukkit Beta 1.3.2 R0.1. can you please fix it?
can someone post or upload his whole config.yml?