Updates the README with new commands and options
All checks were successful
EpicKnarvik97/Books-Without-Borders/pipeline/head This commit looks good
All checks were successful
EpicKnarvik97/Books-Without-Borders/pipeline/head This commit looks good
This commit is contained in:
77
README.md
77
README.md
@@ -12,7 +12,7 @@ Books without Borders has got your back!
|
||||
|
||||
### Features
|
||||
|
||||
- Export written books and book and quills to .txt or .yml files
|
||||
- Export written books and book and quills to .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
|
||||
@@ -24,47 +24,62 @@ Books without Borders has got your back!
|
||||
- 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 title, lore, and book contents
|
||||
- Color and formatting codes can be manually turned into formatting using /formatbook
|
||||
- Clear a book, and start anew with /clearbook
|
||||
- Color and formatting codes can be manually turned into formatting using `/formatbook`
|
||||
- Clear a book, and start anew with `/clearbook`
|
||||
- Formatting and color codes can be turned into formatting once any book is signed. This is enabled through a config
|
||||
value
|
||||
- Change generation of books. Create tattered books for your RPG server!
|
||||
- Optionally, make it impossible to duplicate the original version of a book
|
||||
- Optionally, hit a bookshelf while sneaking to display the contained books. The bookshelf can be given a title and lore
|
||||
with `/setBookshelfData`.
|
||||
- Easily add a title page or chapter page (for an unsigned book, you can add a blank page as well)
|
||||
with `/addBookTitlePage`.
|
||||
- Remove extra blank pages or unneeded chapter pages with `/deleteBookPage`
|
||||
|
||||
#### Group encryption
|
||||
|
||||
- Group encryption allows every player with the bookswithoutborders.decrypt.\<group> permission to decrypt the encrypted
|
||||
book without using a password.
|
||||
|
||||
### Migration from previous versions
|
||||
|
||||
- The `/migrateBooks` command allows for easy fixing of old book naming, changing the title author separator (the
|
||||
default changed from `,` to `¤`, as a comma is a natural character to use in a title), or updating books saved as txt
|
||||
to yml.
|
||||
- Note that if real encryption is enabled, migrating the books will store them unencrypted (like they used to before
|
||||
real encryption was implemented) afterward.
|
||||
|
||||
### Commands:
|
||||
|
||||
An in-game description of available commands is available through the /bwb command.
|
||||
|
||||
| Command | Arguments | Description |
|
||||
|----------------------|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| /bookswithoutborders | None | Displays information about commands (and permissions if the user has bookswithoutborders.admin) |
|
||||
| /copybook | \<# of copies> | Copies the book the player is holding |
|
||||
| /decryptbook | \<key> | Decrypts the book the player is holding. "key" is required and MUST be IDENTICAL to the key used to encrypt the held book |
|
||||
| /deletebook | \<file name or number> | Deletes the specified file in the player's directory |
|
||||
| /deletepublicbook | \<file name or number> | Same as deletebook, but deletes files in the public directory |
|
||||
| /encryptbook | \<key> \[encryption style] | Encrypts the book the player is holding. "key" is required and can be any phrase or number excluding spaces. "style" is not required. Possible values are "DNA" or "" |
|
||||
| /formatbook | None | Formats the held written book (converts color and formatting codes to the corresponding formatted text) |
|
||||
| /givebook | \<file name or number> \<playername> \[# of copies (num)] \[signed (true/false)] | Gives the selected player a book from your personal directory |
|
||||
| /givepublicbook | \<file name or number> \<playername> \[# of copies (num)] \[signed (true/false)] | Same as givebook, but uses books from the public directory |
|
||||
| /loadbook | \<file name or number> \[# of copies] \[signed (true/false)] | Creates a book from the specified file and gives it to the player. If no file is specified, a list of available files is returned. If true is specified, the book will be signed, if false it will be unsigned |
|
||||
| /loadpublicbook | \<file name or number> \[# of copies] \[signed (true/false)] | Same as loadbook, but views files in the public directory |
|
||||
| /reload | None | Reloads BwB's configuration file |
|
||||
| /savebook | \[overwrite (true/false)] | Saves the book the player is holding to a text file in a private directory. If true is specified, a book of the same name by the same author will be overwritten by the new book |
|
||||
| /savepublicbook | \[overwrite (true/false)] | Same as savebook, but saves files in the public directory |
|
||||
| /setbookauthor | \<author> | Sets the author of the book the player is holding |
|
||||
| /setbookgeneration | \<generation> | Sets the generation of the held book (ORIGINAL, COPY_OF_ORIGINAL, COPY_OF_COPY, TATTERED) |
|
||||
| /setbookprice | \<item/eco> \<quantity> | Sets the per-book price to create a book via commands. If "Item", the item in the player's hand in the amount of \<quantity> will be the price. If "Eco", a Vault based economy will be used for price. If neither \<Item/Eco> nor \<quantity> are specified, the current price to create books will be removed. |
|
||||
| /setlore | \<new lore> | Sets the lore of the item the player is holding. Insert the lore_line_separator character to force a new line ("~" by default) |
|
||||
| /settitle | \<title> | Sets the title of the book/item the player is holding |
|
||||
| /unsignbook | None | Un-signs the book the player is holding |
|
||||
| /clearbook | None | Removes all text from the held un-signed book |
|
||||
| /setBookshelfData | \<delete/name/lore> \text> \[more text] | Sets the name/lore for a bookshelf which is shown when peeking at its contents. |
|
||||
| Command | Arguments | Permission | Description |
|
||||
|----------------------|----------------------------------------------------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| /bookswithoutborders | None | | Displays information about commands (and permissions if the user has bookswithoutborders.admin) |
|
||||
| /copybook | \<# of copies> | bookswithoutborders.copy | Copies the book the player is holding |
|
||||
| /decryptbook | \<key> | bookswithoutborders.decrypt | Decrypts the book the player is holding. "key" is required and MUST be IDENTICAL to the key used to encrypt the held book |
|
||||
| /deletebook | \<file name or number> | bookswithoutborders.delete | Deletes the specified file in the player's directory |
|
||||
| /deletepublicbook | \<file name or number> | bookswithoutborders.admin | Same as deletebook, but deletes files in the public directory |
|
||||
| /encryptbook | \<key> \[encryption style] | bookswithoutborders.encrypt | Encrypts the book the player is holding. "key" is required and can be any phrase or number excluding spaces. "style" is not required. Possible values are "DNA" or "" |
|
||||
| /formatbook | None | bookswithoutborders.format | Formats the held written book (converts color and formatting codes to the corresponding formatted text) |
|
||||
| /givebook | \<file name or number> \<playername> \[# of copies (num)] \[signed (true/false)] | bookswithoutborders.give | Gives the selected player a book from your personal directory |
|
||||
| /givepublicbook | \<file name or number> \<playername> \[# of copies (num)] \[signed (true/false)] | bookswithoutborders.givepublic | Same as givebook, but uses books from the public directory |
|
||||
| /loadbook | \<file name or number> \[# of copies] \[signed (true/false)] | bookswithoutborders.load | Creates a book from the specified file and gives it to the player. If no file is specified, a list of available files is returned. If true is specified, the book will be signed, if false it will be unsigned |
|
||||
| /loadpublicbook | \<file name or number> \[# of copies] \[signed (true/false)] | bookswithoutborders.loadpublic | Same as loadbook, but views files in the public directory |
|
||||
| /reload | None | bookswithoutborders.reload | Reloads BwB's configuration file |
|
||||
| /savebook | \[overwrite (true/false)] | bookswithoutborders.save | Saves the book the player is holding to a text file in a private directory. If true is specified, a book of the same name by the same author will be overwritten by the new book |
|
||||
| /savepublicbook | \[overwrite (true/false)] | bookswithoutborders.savepublic | Same as savebook, but saves files in the public directory |
|
||||
| /setbookauthor | \<author> | bookswithoutborders.setauthor | Sets the author of the book the player is holding |
|
||||
| /setbookgeneration | \<generation> | bookswithoutborders.setgeneration | Sets the generation of the held book (ORIGINAL, COPY_OF_ORIGINAL, COPY_OF_COPY, TATTERED) |
|
||||
| /setbookprice | \<item/eco> \<quantity> | bookswithoutborders.setbookprice | Sets the per-book price to create a book via commands. If "Item", the item in the player's hand in the amount of \<quantity> will be the price. If "Eco", a Vault based economy will be used for price. If neither \<Item/Eco> nor \<quantity> are specified, the current price to create books will be removed. |
|
||||
| /setlore | \<new lore> | bookswithoutborders.setlore | Sets the lore of the item the player is holding. Insert the lore_line_separator character to force a new line ("~" by default) |
|
||||
| /settitle | \<title> | bookswithoutborders.settitle | Sets the title of the book/item the player is holding |
|
||||
| /unsignbook | None | bookswithoutborders.unsign | Un-signs the book the player is holding |
|
||||
| /clearbook | None | bookswithoutborders.clear | Removes all text from the held un-signed book |
|
||||
| /setBookshelfData | \<delete/name/lore> \text> \[more text] | bookswithoutborders.editbookshelf | Sets the name/lore for a bookshelf which is shown when peeking at its contents. |
|
||||
| /addBookTitlePage | \[page index] \[title~description] | bookswithoutborders.addtitlepage | Adds a blank page, title page or chapter page depending on input and whether the book is signed |
|
||||
| /deleteBookPage | \<page> | bookswithoutborders.deletepage | Deletes one page from a book |
|
||||
| /migrateBooks | None | bookswithoutborders.admin | Migrates all txt books to yml, and fixes any incorrect filenames. |
|
||||
|
||||
### Permissions:
|
||||
|
||||
@@ -73,7 +88,7 @@ An in-game description of available commands is available through the /bwb comma
|
||||
| bookswithoutborders.* | Grants all permissions |
|
||||
| bookswithoutborders.admin | Grants all permissions |
|
||||
| bookswithoutborders.use | bookswithoutborders.use - Allows player to use commands to save/load/delete in their personal directory, and peeking at bookshelves if enabled |
|
||||
| bookswithoutborders.alterbooks | Allows player to change books' data such as lore/title/author/generation/formatting and un-signing books |
|
||||
| bookswithoutborders.alterbooks | Allows player to change books' data such as lore/title/author/generation/formatting and un-signing books, and setting bookshelf data |
|
||||
| bookswithoutborders.reload | Allows player to reload this plugin |
|
||||
| bookswithoutborders.format | Allows a player to format a book |
|
||||
| bookswithoutborders.save | Allows a player to save books to their personal directory |
|
||||
@@ -102,6 +117,8 @@ An in-game description of available commands is available through the /bwb comma
|
||||
| bookswithoutborders.clear | Allows player to clear the contents of the held writable book |
|
||||
| bookswithoutborders.peekbookshelf | Allows player to left-click a bookshelf to see the contents of the shelf |
|
||||
| bookswithoutborders.editbookshelf | Allows player to set name/lore for bookshelves, used for peeking |
|
||||
| bookswithoutborders.addtitlepage | Allows player to add a blank title page to a book |
|
||||
| bookswithoutborders.deletepage | Allows player to delete a page from a book |
|
||||
|
||||
### Signs
|
||||
|
||||
@@ -126,8 +143,7 @@ The **_decrypt_** sign must have **\[Decrypt]** on its second line. The third li
|
||||
### Configuration options:
|
||||
|
||||
| Option | Description |
|
||||
|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Save_Books_in_Yaml_Format | Whether to use YAML for saved books instead of just storing them as text |
|
||||
|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Max_Number_of_Duplicates | The maximum number of duplicates of a saved book allowed |
|
||||
| Author_Separator | The separator used to separate the book title and the book author |
|
||||
| Lore_line_separator | The separator used to denote a new line in the book/item lore |
|
||||
@@ -142,3 +158,4 @@ The **_decrypt_** sign must have **\[Decrypt]** on its second line. The third li
|
||||
| Format_Book_After_Signing | Whether to automatically format every book when it's signed |
|
||||
| Change_Generation_On_Copy | Whether to display "COPY" or "COPY_OF_COPY" instead of "ORIGINAL" when a book is copied. This also uses the vanilla behavior where a copy of a copy or tattered book cannot be copied further. |
|
||||
| Enable_Book_Peeking | Whether to enable hitting a chiseled bookshelf while sneaking to see the shelf's contents. |
|
||||
| Use_Real_Encryption | Enables true AES encryption instead of the very fake legacy encryption. The encryption key is stored in the book file to allow admin decryption, but looking at the encrypted book in the file system, only reveals the encrypted pages. |
|
||||
Reference in New Issue
Block a user