EpicKnarvik97/Books-Without-Borders
1
0
Fork 0
Code Issues Pull Requests Projects Releases 12 Wiki Activity

Adds a per-book choice for preventing admin decryption when using real encryption
All checks were successful
EpicKnarvik97/Books-Without-Borders/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
Kristian Knarvik
2025-08-21 22:52:22 +02:00
parent 93ce915a30
commit cbe3a977ac
12 changed files with 152 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -35,6 +35,9 @@ Books without Borders has got your back!
- 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`
- If the necessary options are enabled, books can be truly encrypted with the AES cipher, making them impossible to
decrypt without knowing the password. Even admin decryption can be made useless. Only enable if you are aware of the
potential loss caused by forgotten passwords!
#### Group encryption
@@ -101,38 +104,39 @@ An in-game description of available commands is available through the /bwb comma
#### Single permissions
| Node | Description |
|--------------------------------------------|---------------------------------------------------------------------------------|
| bookswithoutborders.addtitlepage | Allows player to add a blank title page to a book |
| bookswithoutborders.bypassauthoronlycopy | Allows player to ignore Author_Only_Copy config setting |
| bookswithoutborders.bypassauthoronlyunsign | Allows player to ignore Author_Only_Unsign config setting |
| bookswithoutborders.bypassauthoronlysave | Allows player to ignore Author_Only_Save config setting |
| bookswithoutborders.bypassbookprice | Allows player to ignore Price_to_create_book config setting |
| bookswithoutborders.clear | Allows player to clear the contents of the held writable book |
| bookswithoutborders.copy | Allows player to copy books |
| bookswithoutborders.decrypt | Allows player to decrypt books |
| bookswithoutborders.decrypt.agroup | Allows player to decrypt books group-encrypted for group "agroup" |
| bookswithoutborders.delete | Allows player to delete books from their personal directory |
| bookswithoutborders.deletepage | Allows player to delete a page from a book |
| bookswithoutborders.editbookshelf | Allows player to set name/lore for bookshelves, used for peeking |
| bookswithoutborders.encrypt | Allows player to encrypt books |
| bookswithoutborders.format | Allows a player to format a book |
| 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.groupencrypt | Allows player to use group-based encryption |
| bookswithoutborders.load | Allows player to load books from their personal directory |
| bookswithoutborders.loadpublic | Allows player to load from the public directory |
| bookswithoutborders.peekbookshelf | Allows player to left-click a bookshelf to see the contents of the shelf |
| bookswithoutborders.reload | Allows player to reload this plugin |
| bookswithoutborders.save | Allows a player to save books to their personal directory |
| bookswithoutborders.savepublic | Allows player to save to the public directory |
| bookswithoutborders.setauthor | Allows player to set the author of the currently held book |
| bookswithoutborders.setbookprice | Allows player to set the cost of creating a book |
| bookswithoutborders.setgeneration | Allows player to change the generation of a book (Original, Copy, Copy of Copy) |
| bookswithoutborders.settitle | Allows player to set the title of the currently held book |
| bookswithoutborders.signs | Allows player to create signs that give/encrypt/decrypt books |
| bookswithoutborders.unsign | Allows player to un-sign books |
| bookswithoutborders.setlore | Allows player to set the lore of the currently held item |
| Node | Description |
|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| bookswithoutborders.addtitlepage | Allows player to add a blank title page to a book |
| bookswithoutborders.bypassauthoronlycopy | Allows player to ignore Author_Only_Copy config setting |
| bookswithoutborders.bypassauthoronlyunsign | Allows player to ignore Author_Only_Unsign config setting |
| bookswithoutborders.bypassauthoronlysave | Allows player to ignore Author_Only_Save config setting |
| bookswithoutborders.bypassbookprice | Allows player to ignore Price_to_create_book config setting |
| bookswithoutborders.clear | Allows player to clear the contents of the held writable book |
| bookswithoutborders.copy | Allows player to copy books |
| bookswithoutborders.decrypt | Allows player to decrypt books |
| bookswithoutborders.decrypt.agroup | Allows player to decrypt books group-encrypted for group "agroup" |
| bookswithoutborders.delete | Allows player to delete books from their personal directory |
| bookswithoutborders.deletepage | Allows player to delete a page from a book |
| bookswithoutborders.editbookshelf | Allows player to set name/lore for bookshelves, used for peeking |
| bookswithoutborders.encrypt | Allows player to encrypt books |
| bookswithoutborders.format | Allows a player to format a book |
| 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.groupencrypt | Allows player to use group-based encryption |
| bookswithoutborders.load | Allows player to load books from their personal directory |
| bookswithoutborders.loadpublic | Allows player to load from the public directory |
| bookswithoutborders.peekbookshelf | Allows player to left-click a bookshelf to see the contents of the shelf |
| bookswithoutborders.reload | Allows player to reload this plugin |
| bookswithoutborders.save | Allows a player to save books to their personal directory |
| bookswithoutborders.savepublic | Allows player to save to the public directory |
| bookswithoutborders.setauthor | Allows player to set the author of the currently held book |
| bookswithoutborders.setbookprice | Allows player to set the cost of creating a book |
| bookswithoutborders.setgeneration | Allows player to change the generation of a book (Original, Copy, Copy of Copy) |
| bookswithoutborders.settitle | Allows player to set the title of the currently held book |
| bookswithoutborders.signs | Allows player to create signs that give/encrypt/decrypt books |
| bookswithoutborders.unsign | Allows player to un-sign books |
| bookswithoutborders.setlore | Allows player to set the lore of the currently held item |
| bookswithoutborders.preventadmindecryption | If use real encryption and prevent admin decryption options are enabled, allows player to disable admin decryption for a book |
### Signs
@@ -172,4 +176,5 @@ 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. Note that real encryption might alter, corrupt or lose a book's contents, so don't use real encryption with books that have no backup in in-game book form or saved book form. |
| 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. Note that real encryption might alter, corrupt or lose a book's contents, so don't use real encryption with books that have no backup in in-game book form or saved book form. |
| Allow_Prevent_Admin_Decryption | Allows players to disable storing the encryption key for an encrypted book. This is only usable for real encryption. This effectively disable admin decryption for the book. Providing the correct password is the only way to decrypt a book without a stored key. THIS IS A DANGEROUS OPTION! |