Adds some README info from the bukkit page

This commit is contained in:
Kristian Knarvik 2021-08-26 20:40:03 +02:00
parent b712c0acb8
commit 0c9f4c431e

View File

@ -1,8 +1,27 @@
#Books Without Borders
# Books Without Borders
This is an attempt at a rewrite of the Books Without Borders plugin. This rewrite uses the
source code given at [the original bukkit page](https://dev.bukkit.org/projects/books-without-borders).
I'm not planning any new features at this time. The only goal is to make it 1.17.1 compliant, but I'll make the code
more maintainable along the way.
While the original version still works, it's using a lot of depreciated function calls which will
most likely break in the future.
most likely break in the future.
## Books without Borders!
Ever wanted to export your book to a text file? Ever want to import it back in? Accidentally sign it too soon? If so, Books without Borders has got your back!
### Features
* Export written books and book and quills to .txt or .yml files
* Import books from files as written books or unsigned books
* Text files can be any length, and the import process fits the content to the correct page length
* Books can be saved privately, or to a directory visible server wide
* Encrypt books to secure their contents [[Courtesy of dorrax]](http://dev.bukkit.org/profiles/dorrax/)
* Give, encrypt, or decrypt held books with signs
* Give players books via command blocks
* Unsign or copy held books with a simple command
* Give first time players a single book or a set of books when they join
* Configurable option to require certain items or pay via Vault compatible economy to create books via command
* Add lore to any item with a simple command
* Supports adding and saving color to titles, lore, and book contents