Lorebooks

Lorebook Guide - Getting Started

What are Lorebooks?

Lorebooks are powerful knowledge bases that enhance your chat interactions by providing dynamic context and world-building elements. Think of them as a collection of knowledge that can be automatically injected into conversations when relevant topics come up.

Creating Your First Lorebook

1. Navigate to the Create page and select "Lorebook"

2. Give your lorebook a name (max 50 characters)

3. Optionally add a thumbnail image

4. Start adding entries

Understanding Entries

Each lorebook can contain multiple entries of different types:

Entry Types

1. Character - For NPCs, historical figures, or important personalities

   • Example: A merchant named "Old Tom" who appears in the town square

   • Best for: Character backgrounds, personalities, relationships

2. Location - For places, buildings, or geographical features

   • Example: The Misty Tavern, a popular gathering spot

   • Best for: Describing settings, landmarks, points of interest

3. Object - For items, artifacts, or important objects

   • Example: The Sword of Dawn, a legendary weapon

   • Best for: Important items, magical artifacts, key plot devices

4. Event - For historical events, festivals, or ongoing situations

   • Example: The Annual Harvest Festival

   • Best for: Historical events, celebrations, important dates

5. Other - For miscellaneous information that doesn't fit other categories

Entry Components

Each entry consists of:

• Name (max 100 characters)

• Description (max 1600 characters)

• Type (selected from the above categories)

• Trigger Keys (max 30 characters each)

Working with Trigger Keys

Trigger keys are words or phrases that, when mentioned in conversation, will cause the entry to be included in the context. Here are some best practices:

Tips for Trigger Keys

• Use variations of names (e.g., "Tom", "Old Tom", "merchant Tom")

• Include common misspellings

• Keep them specific enough to avoid false triggers

• Use both singular and plural forms when relevant

Example Trigger Keys

Character Entry: "Old Tom"
Trigger Keys:
- "Old Tom"
- "merchant Tom"
- "Tom the merchant"

Best Practices

1. Keep Descriptions Focused

   • Write clear, concise descriptions

   • Include the most important information first

   • Use proper formatting for readability

2. Organize Your Entries

   • Group related entries together

   • Use consistent naming conventions

   • Keep your lorebook focused on a specific theme or setting

3. Effective Triggers

   • Use specific, unique trigger words

   • Avoid overly common words

   • Consider context when creating triggers

4. Regular Maintenance

   • Review and update entries regularly

   • Remove unused or redundant entries

   • Keep information consistent with your story

Example Lorebook Structure

Lorebook: "Town of Misthaven"

1. Character Entry:
   Name: Old Tom the Merchant
   Description: A jolly old merchant who's been running the market stall for 30 years...
   Triggers: "Old Tom", "merchant Tom", "Tom's stall"

2. Location Entry:
   Name: The Misty Tavern
   Description: A cozy tavern known for its warm fires and excellent mead...
   Triggers: "Misty Tavern", "tavern", "inn"

3. Event Entry:
   Name: Harvest Festival
   Description: Annual celebration held during the autumn equinox...
   Triggers: "harvest festival", "autumn feast", "equinox celebration"

Tips for Success

1. Start Small

   • Begin with essential entries

   • Expand gradually as needed

   • Focus on quality over quantity

2. Test Your Triggers

   • Verify triggers work as intended

   • Adjust if they're too broad or narrow

   • Check for unintended activations

3. Maintain Consistency

   • Keep information aligned with your story

   • Update entries as your world evolves

   • Remove outdated information

Common Mistakes to Avoid

1. Overly Long Descriptions

   • Stay concise and within the 1600 character limit

   • Keep descriptions focused and relevant

   • Break up long entries into smaller ones

2. Too Many Triggers

   • Avoid excessive trigger keys

   • Keep triggers specific and meaningful

   • Remove redundant triggers

3. Inconsistent Information

   • Double-check facts across entries

   • Maintain continuity

   • Update related entries together

Advanced Tips

1. Cross-Referencing

   • Link related entries through their descriptions

   • Maintain consistent terminology

   • Create a network of connected information

2. Context Awareness

   • Consider when entries should trigger

   • Think about the flow of conversation

   • Avoid overwhelming the chat with too much information

3. Regular Reviews

   • Periodically review and update entries

   • Remove unused or redundant information

   • Keep your lorebook clean and efficient

Remember: A well-organized lorebook can greatly enhance your chat experience by providing rich, contextual information exactly when it's needed.