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.

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.

Templates

Create custom book templates by adding YAML files to the 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/
Items 
4x Occultist Books
1x Wizard Book
Pieces 
4x Occultist Books
1x Wizard Book
1x Storage Container
2x Book Wheels (one with and one without books)
Prefabs 
You can find an always up-to-date list of all prefabs on the Database page.
Recipe & Crafting 
You can find an always up-to-date list of all crafting & recipes on the Database page.
Media
Changelog 
1.1.7 • Rebranded to ReadMe.
1.1.6 • Internal restructure.
1.1.5 • Internal restructure.
1.1.4 • Fixed an error when the server checked for admin.
1.1.3 • Added support for YAML meaning you can now create YAML templates to apply to books in-game.
        Templates are stored in config/CookieMilk/ReadMe/Books.
      • Added TextMeshPro Rich Text support including clickable links.
        Visit Supported Rich Text Tags for supported tags. 
      • Added two new books called Guide and Example Book, both which will be given to new players on spawn.
        These books will only be given once per spawn and the flag can be found in config/CookieMilk/ReadMe/PlayerFlags.
      • Added configuration setting to change how both books are distributed - Admin, Everyone or None.
      • Added configuration setting to change if books can be edited or not - Default, Editable, ReadOnly.
      • Added configuration setting to change if the book commands can only be used by an admin or not.
1.1.2 • Fixed inventory not being able to be closed when you open a book.
1.1.1 • Updated for the new Valheim Patch.
      • Updated ServerSync.
1.1.0 • Updated for the new Valheim Patch.
1.0.9 • Updated ReadMe to link directly to the mods own page on my website.
1.0.8 • Updated PieceManager.
1.0.7 • Updated PieceManager.
1.0.6 • Updated for Bog Witch.
1.0.5 • Fixed InvalidCastException: Specified cast is not valid error.
      • Added the ability for the books to talk like in the mod InteractWithMe.
1.0.4 • Updated PieceManager.
1.0.3 • Remade the bookwheels pieces to fix them being placed high up in the air.
1.0.2 • Added a Wizard book item and piece.
      • Shrunk textures so the mod is now half the size.
1.0.1 • Added ServerSync and FileWatcher.
1.0.0 • Release
Requirements:
  • BepInEx 5.4.2333 or later
  • Valheim 0.221.4 or later
Installation:
  • Download the latest version from Thunderstore.
  • Extract the downloaded zip file.
  • Copy the contents to your Valheim/BepInEx/plugins folder.
  • 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.
Support