Clean em-dashes and smart quotes from markdown files

This commit is contained in:
Nyx Nimmerverse
2026-08-02 16:09:49 +00:00
parent 2cb32029a6
commit 192ac8f702
13 changed files with 177 additions and 177 deletions

View File

@@ -1,4 +1,4 @@
# mod-to-sknpack Extract Mod Lore into SkyrimNet Knowledge Packs
# mod-to-sknpack - Extract Mod Lore into SkyrimNet Knowledge Packs
A pipeline that reads record data out of specific Skyrim mods via xEdit, then
distills it into `.sknpack` files that slot in alongside the Oghma vanilla
@@ -14,7 +14,7 @@ authored books, quest journals, unique artifacts, and named locations into
the game world. Without mod-specific knowledge packs, SkyrimNet NPCs will
either hallucinate about these or refuse to engage.
The authored narrative content is already *in the plugin files* we just
The authored narrative content is already *in the plugin files* - we just
need to lift it out, clean it, categorize it, and grade it. xEdit gives us
deterministic record access; the `.sknpack` format is plain JSON; the
glue between them is this project.
@@ -37,7 +37,7 @@ In-game NPC knowledge
**Why two stages:** xEdit's Pascal is painful for JSON escaping and for
cleaning book-body markup (`<p>`, `<br>`, `<font face='$HandwrittenFont'>`).
Python handles those trivially. The JSONL intermediate is also *inspectable*
we can eyeball what xEdit actually found before any transformation runs.
- we can eyeball what xEdit actually found before any transformation runs.
## Target record signatures
@@ -83,15 +83,15 @@ Pack envelope: `skyrimnet_knowledge_pack` with `name`, `description`,
## Importance grading (carries over from Oghma)
- **0.75** Authored narrative: book text, quest journals, named-artifact
- **0.75** - Authored narrative: book text, quest journals, named-artifact
backstory. The "scholar" tier.
- **0.50** Locations, spells, visual descriptions.
- **0.40** Generic items, display plaques, unnamed NPCs. The "commoner"
tier provides scaffolding without dominating token budget.
- **0.50** - Locations, spells, visual descriptions.
- **0.40** - Generic items, display plaques, unnamed NPCs. The "commoner"
tier - provides scaffolding without dominating token budget.
Where a single topic has both authored and generic variants (e.g. a named
weapon has both its lore-book entry and a terse display plaque), emit
*both* SkyrimNet's ranking picks the right depth for the NPC.
*both* - SkyrimNet's ranking picks the right depth for the NPC.
## Pack split convention
@@ -101,28 +101,28 @@ Nimmersky_-_{Mod}_-_{Category}.sknpack
Examples for Legacy of the Dragonborn:
- `Nimmersky_-_LOTD_-_Displays.sknpack` per-relic display descriptions
- `Nimmersky_-_LOTD_-_Books.sknpack` Explorer's Guide series, Auryen's
- `Nimmersky_-_LOTD_-_Displays.sknpack` - per-relic display descriptions
- `Nimmersky_-_LOTD_-_Books.sknpack` - Explorer's Guide series, Auryen's
journals, in-game books
- `Nimmersky_-_LOTD_-_Museum.sknpack` one LOCATION entry per wing (Hall
- `Nimmersky_-_LOTD_-_Museum.sknpack` - one LOCATION entry per wing (Hall
of Heroes, Dragonborn Hall, Daedric, Library, Safehouse, Natural Science,
Dwemer, Guildhouse, Hall of Lost Empires, Airship), all with
`location="Solitude"`
- `Nimmersky_-_LOTD_-_Quests.sknpack` quest journals (Auryen's commission
- `Nimmersky_-_LOTD_-_Quests.sknpack` - quest journals (Auryen's commission
lines, relic-hunt objectives)
## Mod-specific design notes
### Legacy of the Dragonborn (LOTD)
- Museum wings are the natural chunking unit for LOCATION entries LOTD
- Museum wings are the natural chunking unit for LOCATION entries - LOTD
tags them via keywords and has dedicated location records.
- The Explorer's Guide books are pure gold (0.75) long-form authored
- The Explorer's Guide books are pure gold (0.75) - long-form authored
narrative about relic backstories.
- Display plaques are mostly terse ("Blade of Woe dagger once carried
- Display plaques are mostly terse ("Blade of Woe - dagger once carried
by the Dark Brotherhood assassin Astrid"). These go at 0.40.
### Vigilant, Wyrmstooth, Beyond Skyrim
- Larger quest arcs QUST dumping becomes more valuable than for LOTD.
- Larger quest arcs - QUST dumping becomes more valuable than for LOTD.
- Beyond Skyrim: Bruma has whole LCTN hierarchies to preserve (province
→ hold → settlement → dungeon).
@@ -145,7 +145,7 @@ Examples for Legacy of the Dragonborn:
## Not yet decided
- Whether to go via ChromaDB (matches Oghma architecture ingestion into
- Whether to go via ChromaDB (matches Oghma architecture - ingestion into
iris-dev, then `export_packs.py`-style exporter) or straight to
`.sknpack` from the JSONL (simpler, no RAG search over mod content).
- Whether to generate two importance tiers per topic by running an LLM