Lore is a simple and lightweight plugin that is aimed to give your server a more diverse and informative experience by allowing administrators to easily create, manage and hand-out books to players either on their first login or upon respawning. This is a must have plugin for any RPG server out there!
Please consider passing me a token of your appreciation for creating and maintaining this plugin by donating.
Features
Ability to save books to a YAML file for use with Lore.
Ability to set one or multiple saved books that players will receive when first logging in to the server.
Ability to set one or multiple saved books that players will receive when respawning after death.
Ability to set one or multiple saved books that players cannot remove from their inventory.
Ability to set the messages used by Lore in the config.yml.
Ability to give a copy of a saved book to players at any time.
Ability to update an existing book in Lore.
Ability to turn a signed book into an unsigned book.
If upgrading from Lore 1.x.x to Lore 2.x.x, delete your config.yml!
Install Lore to your plugins directory and start your server.
Join your server.
Hold a signed book in your hand and type `/lore create [book]`, replace [book] with whatever you want to refer to that book as when using Lore commands.
Follow the command reference chart below, make sure you have permissions setup as well!
How it Works
If a book in Lore's book library has the "join" flag set to true, it will give that book to a player who has never played on that server before.
If a book in Lore's book library has the "respawn" flag set to true, it will give that book to a player when they respawn after death.
If a book in Lore's book library has the "sticky" flag set to true, it will not let them take it out of their hotbar or inventory.
If you want to modify an existing book, just hold the book in your hand and do '/lore unsign'!
If you want to update an existing book configuration in Lore, just hold the book in your hand and do '/lore update [book]'.
If the "allow-villager-trades" option is set to true, it will allow players to trade Lore books to villagers.
All of the above requires proper permission setup.
If a message in the config.yml is empty, no message is sent to the player.
Planned
Nothing at this time.
Command
Description
Console Support
/lore give [player] [book]
Gives the specified player a copy of the specified book from Lore's book library.
Yes
/lore create [name]
Adds the held book to Lore's book library with the specified name.
No
/lore join [book] <true/false>
Sets the "join" flag for the specified book as either true or false.
Yes
/lore list
Displays the list of registered books to the command sender.
Yes
/lore remove [book]
Removes the specified book from Lore's book library.
Yes
/lore respawn [book] <true/false>
Sets the "respawn" flag for the specified book as either true or false.
Yes
/lore sticky [book] <true/false>
Sets the "sticky" flag for the specified book as either true or false.
Yes
/lore unsign
Sets the currently held book as an unsigned book to allow editing.
No
/lore update [book]
Updates an existing Lore book with the currently held books' information.
No
Permission
Description
lore.command.*
Combines all 'command' permissions under one wildcard.
lore.command.create
Allows the player to add a new book to the book library.
lore.command.give
Allows the player to give any book to another player.
lore.command.join
Allows the player to set the flag for "join" on Lore books.
lore.command.list
Allows the player to use the list command.
lore.command.remove
Allows the player to remove a book from Lore's book library.
lore.command.respawn
Allows the player to set the flag for "respawn" on Lore books.
lore.command.sticky
Allows the player to set the flag for "sticky" on Lore books.
lore.command.unsign
Allows the player to turn a signed book into an unsigned book
lore.command.update
Allows the player to update an existing book in the book library.
lore.join.obtain
Allows the player to obtain all books with the "join" flag set as true.
lore.respawn.obtain
Allows the player to obtain all books with the "respawn" flag set as true.
lore.sticky.bypass
Allows the player to not be bound by the sticky status of a book.
I would like to have a book for each world a new player enters is it possible to create one book for each world. Also it looks like the join command is not currently working I would really appreciate it if an update could fix this :)
Well on my server i have a plugin called xAuth used for logging in and out so when players join the server I would like the Lore book in item slot number 1 so they can see rules, how to login, password reset, and links without the need to to select item slots. And for item slot number 2 i have a plugin called Magic Clock for players on hub to mess with. And also please add a feature that they always have the book on every join (might be wrong if this feature is already available).
@EDWIN3150
I'll consider it however at the moment I don't really see the need for that feature. Maybe if you can give me some scenarios that would make it worth adding.
@triarry
I'll look into the first part of your request but that probably will not happen anytime soon.
Is there a way to make it so that they'll only receive a book when we make a change to it; For example, newspaper style? We'd like to have a backlog of all previous books as well.
I can understand flipping through the pages would get annoying after a while. But there isn't much more I can offer from within Bukkit.
Hopefully the '/lore unsign' command will be of use in 2.2, which literally just takes the signed book you are holding and puts the contents into a 'Book and Quill' item. Allowing you to add and edit pages in that book and then signing it again (and even allowing you to change the book title).
I've gone ahead and moved my 'Lore 2.2' page as the main page of this project. You can review the usage and permissions for the unsign and update commands.
In Lore 2.2 (waiting for approval) you will be able to hold a signed book and do '/lore unsign' then modify the book, sign it and do '/lore update [book]' to replace an existing Lore book with whatever you're holding. You don't need to do it in that order, any book will be valid for the update command so long as it is signed.
The best thing to do would be to create a book from the text and then convert it over in-game. I can't really speak to the ease of editing, I'll look into that some soon.
I'm asking if there is an efficient way of taking plain text from a document (Like a .txt or something) and putting it into the format required for the books.
Also, editing a pre-existing book without screwing up the YAML.
I'm not entirely sure what you are asking.
If you want to convert an in-game book to the YAML file Lore uses, then simply hold the book in your hand and perform the '/lore create [book]' command. Replace [book] with whatever you wish to name the YAML file (example: '/lore create apple' will result in apple.yml under /plugin/Lore/books)
It shouldn't have ever had an issue with other plugins. If you're talking about Forge mods then I cannot promise you that it will work without issue since this was built on and for Bukkit and MCPC+ doesn't always play nice with plugins from Bukkit.
I would like to have a book for each world a new player enters is it possible to create one book for each world. Also it looks like the join command is not currently working I would really appreciate it if an update could fix this :)
@NinjaGrinch
Well on my server i have a plugin called xAuth used for logging in and out so when players join the server I would like the Lore book in item slot number 1 so they can see rules, how to login, password reset, and links without the need to to select item slots. And for item slot number 2 i have a plugin called Magic Clock for players on hub to mess with. And also please add a feature that they always have the book on every join (might be wrong if this feature is already available).
@EDWIN3150 I'll consider it however at the moment I don't really see the need for that feature. Maybe if you can give me some scenarios that would make it worth adding.
@triarry I'll look into the first part of your request but that probably will not happen anytime soon.
@NinjaGrinch
Is there a way to make it so that they'll only receive a book when we make a change to it; For example, newspaper style? We'd like to have a backlog of all previous books as well.
Could you add a feature so we put what item slot we want the Lore book in?
@Owner1901
You'll need to give yourself and anyone else who needs to get this book during their first join to your server the 'lore.join.obtain' permission.
Those who have joined before will not receive it.
whenever i make a book and enable flag join on the book, when i join the book is nowwhere in my inventitory
@My_Name_Was_Stolen
I can understand flipping through the pages would get annoying after a while. But there isn't much more I can offer from within Bukkit.
Hopefully the '/lore unsign' command will be of use in 2.2, which literally just takes the signed book you are holding and puts the contents into a 'Book and Quill' item. Allowing you to add and edit pages in that book and then signing it again (and even allowing you to change the book title).
I've gone ahead and moved my 'Lore 2.2' page as the main page of this project. You can review the usage and permissions for the unsign and update commands.
@NinjaGrinch That is great, except for in scenarios where you want to edit or add pages in the middle of a 30 page book.
@My_Name_Was_Stolen
In Lore 2.2 (waiting for approval) you will be able to hold a signed book and do '/lore unsign' then modify the book, sign it and do '/lore update [book]' to replace an existing Lore book with whatever you're holding. You don't need to do it in that order, any book will be valid for the update command so long as it is signed.
Let me know if you have any issues.
@My_Name_Was_Stolen
The best thing to do would be to create a book from the text and then convert it over in-game. I can't really speak to the ease of editing, I'll look into that some soon.
@NinjaGrinch
I'm asking if there is an efficient way of taking plain text from a document (Like a .txt or something) and putting it into the format required for the books. Also, editing a pre-existing book without screwing up the YAML.
@My_Name_Was_Stolen
I'm not entirely sure what you are asking. If you want to convert an in-game book to the YAML file Lore uses, then simply hold the book in your hand and perform the '/lore create [book]' command. Replace [book] with whatever you wish to name the YAML file (example: '/lore create apple' will result in apple.yml under /plugin/Lore/books)
Is there any sort of tool one might use to make books in the proper format required for the backend files this plugin uses?
@ursak
It shouldn't have ever had an issue with other plugins. If you're talking about Forge mods then I cannot promise you that it will work without issue since this was built on and for Bukkit and MCPC+ doesn't always play nice with plugins from Bukkit.
Does this work with mods now?
@My_Name_Was_Stolen
Thanks for the heads-up, I went ahead and fixed that with Lore 2.1.2.
There is a small typo. When it lists the commands ingame, it says the command to toggle sticky status is "/lore stick" instead of "/lore sticky"
Oh, this is exactly what I've been looking for for my server! Amazing! I am going to display the server news to the player using this plugin.
@NinjaGrinch
Thank you, it works perfectly!