diff --git a/README.md b/README.md index 7edc14c..8dbf084 100644 --- a/README.md +++ b/README.md @@ -25,28 +25,95 @@ 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 +* Formatting and color codes can be turned into formatting once any book is signed. This is enabled through a config + value #### Group encryption * Group encryption allows every player with the bookswithoutborders.decrypt.\ permission to decrypt the encrypted book without using a password. +### Commands: + +An in-game description of available commands is available through the /bwb command. + +* /bookswithoutborders - Displays information about commands (and permissions if the user has bookswithoutborders.admin) +* /copybook <# of copies> - Copies the book the player is holding +* /decryptbook - Decrypts the book the player is holding. "key" is required and MUST be IDENTICAL to the key used + to encrypt the held book +* /deletebook - Deletes the specified file in the player's directory +* /deletepublicbook - Same as deletebook, but deletes files in the public directory +* encryptbook \[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 - Formats the held written book (converts color and formatting codes to the corresponding formatted text) +* /givebook \[# of copies (num)] \[signed (true/false)] - Gives the selected player a + book from your personal directory +* /givepublicbook \[# of copies (num)] \[signed (true/false)] - Same as givebook, but + uses books from the public directory +* /loadbook \[# 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 \[# of copies] \[signed (true/false)] - Same as loadbook, but views files in the + public directory +* /reload - 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 - Sets the author of the book the player is holding +* /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 will be the price. If "Eco", a Vault based economy will be used for + price. If neither nor are specified, the current price to create books will be removed. +* /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 - Sets the title of the book/item the player is holding +* /unsignbook - Un-signs the book the player is holding + +### Permissions: + +* bookswithoutborders.* - Grants all permissions +* bookswithoutborders.admin - Grants all permissions +* bookswithoutborders.use - Allows player to use commands to save/load/delete in their personal directory +* bookswithoutborders.alterbooks - Allows player to change books' data such as lore/title/author/formatting and + unsigning books +* bookswithoutborders.format - Allows a player to format a book +* bookswithoutborders.save - Allows a player to save books to their personal directory +* bookswithoutborders.load - Allows player to load books from their personal directory +* bookswithoutborders.delete - Allows player to delete books from their personal directory +* bookswithoutborders.unsign - Allows player to un-sign books +* bookswithoutborders.copy - Allows player to copy books +* bookswithoutborders.loadpublic - Allows player to load from the public directory +* bookswithoutborders.savepublic - Allows player to save to the public directory +* bookswithoutborders.encrypt - Allows player to encrypt books +* bookswithoutborders.groupencrypt - Allows player to use group-based encryption +* bookswithoutborders.decrypt - Allows player to decrypt books +* bookswithoutborders.decrypt.agroup - Allows player to decrypt books group-encrypted for group "agroup" +* bookswithoutborders.signs - Allows player to create signs that give/encrypt/decrypt books +* bookswithoutborders.give - Allows player to give another player one of their privately saved books +* bookswithoutborders.givepublic - Allows a player to give another player a book from the public directory +* bookswithoutborders.settitle - Allows player to set the title of the currently held book +* bookswithoutborders.setauthor - Allows player to set the author of the currently held book +* bookswithoutborders.setlore - Allows player to set the lore of the currently held item +* bookswithoutborders.bypassauthoronlycopy - Allows player to ignore Author_Only_Copy config setting +* bookswithoutborders.bypassbookprice - Allows player to ignore Price_to_create_book config setting +* bookswithoutborders-setbookprice - Allows player to set the cost of creating a book + ### Signs -This plugin supports several custom signs with special functionality. Each plugin sign must have [BwB] on its first +This plugin supports several custom signs with special functionality. Each plugin sign must have \[BwB] on its first line. #### Give sign -The **_give_** sign must have **[Give]** on its second line. The third and fourth line contains the book to be loaded. +The **_give_** sign must have **\[Give]** on its second line. The third and fourth line contains the book to be loaded. This can either be a numerical id pointing to a publicly saved book, or the full text identifier of the book (book name, author). #### Encrypt sign -The **_encrypt_** sign must have **[Encrypt]** on its second line. The third line must contain the encryption key The +The **_encrypt_** sign must have **\[Encrypt]** on its second line. The third line must contain the encryption key The fourth line can be empty or contain "dna" for dna-based encryption. #### Decrypt sign -The **_decrypt_** sign must have **[Decrypt]** on its second line. The third line must contain the decryption key \ No newline at end of file +The **_decrypt_** sign must have **\[Decrypt]** on its second line. The third line must contain the decryption key \ No newline at end of file