ReadMe
About
Adds fully functional books to Valheim that can be written in, read, and displayed as decorations.
All book content is saved with the item and persists between game sessions.
Features
• Write and read books with persistent content that saves between sessions.
• Supports rich text formatting and clickable links in book content.
• Two formats: carry books in inventory or place them as decorations.
• A template system that allows you to write books outside of the game.
• Supports rich text formatting and clickable links in book content.
• Two formats: carry books in inventory or place them as decorations.
• A template system that allows you to write books outside of the game.
How to Use
1. Craft one of the avaible books at the Worbench.
2. Right-click any book in your inventory to open the book UI.
3. Start writing to your hearts content either right in game or outside of the game.
4. Hold Left Shift + Left Ctrl and right-click a book to create a copy (requires materials).
5. To create books outside of the game and use the templates, see below.
2. Right-click any book in your inventory to open the book UI.
3. Start writing to your hearts content either right in game or outside of the game.
4. Hold Left Shift + Left Ctrl and right-click a book to create a copy (requires materials).
5. To create books outside of the game and use the templates, see below.
Templates
Create custom book templates by adding YAML files to the
The mod includes a guide and example template to get you started.
Outputs help in the console.
Usage:
Applies a template to an existing book in your inventory.
If your book is called Viking then replace bookname with Viking, same goes for template.
Lists all books in your inventory
Lists all available book templates.
Output shows templates from YAML files in
BepInEx/config/CookieMilk/ReadMe/Templates folder.The mod includes a guide and example template to get you started.
Title: My Custom Book ReadOnly: false MaxPages: 10 TitleFont: '' # Optional: Font asset name TitleFontSize: 24 # Optional: Font size for title BodyFont: '' # Optional: Font asset name for content BodyFontSize: 16 # Optional: Font size for content Template: | Page 1 content goes here Can span multiple lines New paragraphs are preserved [b]Supports rich text[/b] and [color=red]colors[/color]Commands: (these can be used either in the console or chat, if used in chat, add /)
book_template
Outputs help in the console.
book_template
Usage:
book_template bookname templatename
Applies a template to an existing book in your inventory.
If your book is called Viking then replace bookname with Viking, same goes for template.
list_books
Lists all books in your inventory
list_templates
Lists all available book templates.
Output shows templates from YAML files in
BepInEx/config/ReadMe/Books/
4x Occultist Books 1x Wizard Book
4x Occultist Books 1x Wizard Book 1x Storage Container 2x Book Wheels (one with and one without books)
You can find an always up-to-date list of all prefabs on the Database page.
You can find an always up-to-date list of all crafting & recipes on the Database page.
Requirements:
- BepInEx 5.4.2333 or later
- Valheim 0.221.4
Installation:
- Download the latest version from Thunderstore.
- Extract the downloaded zip file.
- Copy the contents to your
Valheim/BepInEx/pluginsfolder. - Start the game and enjoy!
Server Installation:
- Install the mod on your server following the same steps as above.
- Ensure all clients have the same version installed.
- Server-side only installation is not supported - all players need the mod.