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 saw that you do not support multiple books, but could you do so in the future? I could see writing a book for each of the servers plugins, explaining how players can use these plugins, being very useful. I could write books on how I have configured and how to use Lockette, Stables, arena-plugins and so on. Players wondering on how to use these features on my server could then type (example) "/lore Lockette" or "/lore Arena" (customizable name) and read my instructions as to how to use these plugins on my server.
Here is how I imagine it could work:
- Write book
- Type "/lore save *name*"
- This book is then available in a virtual library players can view with the command /lore.
- "/lore *name*" gives the the specified book
- "/lore set" is still there, doing what it does best - giving new players an introduction to the server.
I now use this plugin to inform new players the basics of what my server is about when they first join the server, but this feature to add more books players could access to explain more deeply than any one book ever could would be amazing :)
@altair123ezio As soon as it is approved, 1.0.3 should be properly functioning now. Make sure you update your permissions though as I changed them a bit.
I saw that you do not support multiple books, but could you do so in the future? I could see writing a book for each of the servers plugins, explaining how players can use these plugins, being very useful. I could write books on how I have configured and how to use Lockette, Stables, arena-plugins and so on. Players wondering on how to use these features on my server could then type (example) "/lore Lockette" or "/lore Arena" (customizable name) and read my instructions as to how to use these plugins on my server.
Here is how I imagine it could work: - Write book - Type "/lore save *name*" - This book is then available in a virtual library players can view with the command /lore. - "/lore *name*" gives the the specified book - "/lore set" is still there, doing what it does best - giving new players an introduction to the server.
I now use this plugin to inform new players the basics of what my server is about when they first join the server, but this feature to add more books players could access to explain more deeply than any one book ever could would be amazing :)
@altair123ezio As soon as it is approved, 1.0.3 should be properly functioning now. Make sure you update your permissions though as I changed them a bit.
@NinjaGrinch
ok thanks,i am doing HarryPotter server and i need this plugin,thanks for all
@YuuExussum No.
@altair123ezio I dun derped with commands, will push a fix for it tomorrow (July 19th CST time)
Can you set multiple books?
when i write ``lore set´´ the console say me /lore [arguments]
@Terty_Tree The latest version should resolve most if not all of the issues.
@Terty_Tree Did you actually follow the instructions and setup a book?
@Compressionist Was working fine for me when I tested it and have had no negative reports elsewhere.
Plugin is not working, I am using the commands but nothing happens, all permissions are set up correctly.
I get a internal server error while trying to give a book to someone, Also i can't even do /lore set nothing pops up.
NinjaGrinch is a great dev! Going to try this beast out sometime soon