-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration
Applies to all versions (1.21.1 and 26.2).
Vellumli registers a NeoForge client config. Values are read through VellumliConfig / VellumliAPI.get().getConfig().
| Option | Type | Default | Meaning |
|---|---|---|---|
disableAdvancementLocking |
boolean | false |
Disable advancement locking for all books, making every entry visible. Sets the config flag advancements_disabled. |
noAdvancementBooks |
list of strings | [] |
Book ids to disable advancement locking for individually, for example ["mymod:mymod_guide"]. Sets the config flag advancements_disabled_<bookid>. |
testingMode |
boolean | false |
Enables testing mode. Does nothing by itself; use the testing_mode flag in your books. |
inventoryButtonBook |
string | "" |
The id of a book to show in the player's inventory, replacing the recipe book button. |
useShiftForQuickLookup |
boolean | false |
Use Shift instead of Ctrl for the inventory quick lookup feature. |
textOverflowMode |
enum | RESIZE |
How text that does not fit is handled: OVERFLOW (let it run off the page), TRUNCATE (cut it off) or RESIZE (shrink everything to fit). Relog after changing. |
quickLookupTime |
int | 10 |
How long, in ticks, the quick lookup key must be held before the book opens. |
A book can override the overflow mode per book with the text_overflow_mode field in book.json.
A config flag is a named boolean that the flag fields on categories, entries, pages and components query. Mods can set their own flags with VellumliAPI.get().setConfigFlag("mymod:flag", true).
Vellumli sets these flags itself:
| Flag | True when |
|---|---|
advancements_disabled |
disableAdvancementLocking is on. |
advancements_disabled_<bookid> |
The given book is listed in noAdvancementBooks. |
testing_mode |
testingMode is on. |
mod:<modid> |
The mod is loaded. |
debug |
Running in a development environment. |
Querying an unknown flag logs a warning and evaluates to false.
A flag string supports a small expression syntax:
- A leading
!negates the flag:!testing_mode. - A leading
&ANDs a comma-separated list:&mod:mymod,testing_mode. - A leading
|ORs a comma-separated list:|mod:othermmod,testing_mode.
Flag names are matched case-insensitively.
Vellumli is a fork of Patchouli by Vazkii and williewillus. This documentation is licensed under CC BY-NC-SA 3.0. Not affiliated with or endorsed by the Patchouli authors.