LitLiterature

For the most up-to-date and complete documentation, please visit the official LitLiterature page.

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/LitLiterature/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/LitLiterature/Books/

Documentation, support, contact information can be found via the links below.

• Website • Discord Server •

Thank you so much for using my mods and the support ❤️

• PayPal • BuyeMeACoffee •