Skip to content

Commit 74739e9

Browse files
committed
docs: add recently unlocked book property
- Describes the new book sidebar button toggle - Explains the paginated view and entry sorting - Mentions the feature is enabled by default
1 parent 9c2d8fd commit 74739e9

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

  • docs/basics/structure
  • versioned_docs/version-26.1/basics/structure

docs/basics/structure/book.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,14 @@ If set to `true`, the book will not throw an error when trying to open a book wi
255255

256256
The main use for this is for mods that have external translators for their books, where translations might be outdated after entries have been removed or moved.
257257

258+
### **show_recently_unlocked** (Boolean, _optional_)
259+
260+
Default value: `true`.
261+
262+
If set to `true`, a "Recently Unlocked" button will be shown in the book sidebar (above the bookmarks button). Clicking it opens a paginated view of all entries the player has unlocked, sorted with unread entries first and then by most recent unlock timestamp.
263+
264+
Set to `false` to hide the button.
265+
258266
## Usage Examples
259267

260268
`/data/<mod_id>/modonomicon/books/<book_id>/book.json`:

versioned_docs/version-26.1/basics/structure/book.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,14 @@ If set to `true`, the book will not throw an error when trying to open a book wi
255255

256256
The main use for this is for mods that have external translators for their books, where translations might be outdated after entries have been removed or moved.
257257

258+
### **show_recently_unlocked** (Boolean, _optional_)
259+
260+
Default value: `true`.
261+
262+
If set to `true`, a "Recently Unlocked" button will be shown in the book sidebar (above the bookmarks button). Clicking it opens a paginated view of all entries the player has unlocked, sorted with unread entries first and then by most recent unlock timestamp.
263+
264+
Set to `false` to hide the button.
265+
258266
## Usage Examples
259267

260268
`/data/<mod_id>/modonomicon/books/<book_id>/book.json`:

0 commit comments

Comments
 (0)