LORKHAN

Home Overview Installation Configuration Roleplay Settings Morrowind Settings Large Language Models Local LLM Guide Text-to-Speech Speech-to-Text Modders Guide FAQ Remote Hosting Logs and Debugging

Beta downloads Discord Patreon Mod Code Server Code

Modders Guide

Start with supported data customization. Native or Lua changes need a matching client build.

Create and Import NPC Biographies

Biographies provide reusable character information. Live NPC records also contain playthrough-specific state; keep those distinct when preparing a mod.

  1. Open Configuration → NPC Biographies.
  2. Choose Download Example CSV and use that file's headers and example as your template.
  3. Edit a small batch in a CSV-aware editor. Preserve headers and properly quote commas, quotes and line breaks. Save as UTF-8 CSV.
  4. Back up existing custom data, then use Upload CSV.
  5. Inspect the imported records. Activate a matching NPC and check its biography and voice in LORKHAN NPCs.
  6. Only then import the remaining batch. Use Export Custom NPCs to share or back up custom entries.

Base IDs identify game records; live reference IDs distinguish placed actors. Names are not unique identifiers. Do not import Skyrim biography CSVs unchanged.

Voice presets

Biography data can include Voice ID and supported voice-filter presets. Verify the imported values in an activated NPC’s editor, then preview the voice with the intended connector.

Only distribute audio and character assets you have permission to share. A local sample path on your development PC is not a portable voice asset.

World knowledge

Add relevant setting information through Oghma’s knowledge tools. Keep each article focused on one topic and test retrieval in context. Avoid mixing private NPC memories into general world knowledge.

Reference groups

Use editable reference groups for multiple references that intentionally represent the same character. Do not merge unrelated actors just because their names or base records match.

Actions and Game Integration

The Action Editor controls the actions offered to the model and their confirmation settings. Changing a description does not add a new engine capability.

  1. Start with an implemented action and inspect its parameters and confirmation behavior.
  2. Keep the description specific. Do not promise Skyrim-only interactions in Morrowind.
  3. Test acceptance and refusal when confirmation is enabled.
  4. A new action requires matching server routing and client behavior. Build and test both together.

The bridge uses typed requests. Arbitrary console commands in a prompt do not become executable actions. Follow the packaged developer documentation for protocol and build instructions.

Source and builds

The LORKHAN repository contains the native bridge, Lua mod and build instructions. LorkhanServer contains the server. Both use GPL-3.0 licensing; third-party components retain their own notices.

Use the matching beta source package and build instructions when rebuilding a release. Keep the pinned engine, native bridge and Lua files together. Do not distribute Bethesda game data.