Home

Welcome to the PyKotor Wiki

PyKotor is an LGPL-3.0-or-later monorepo whose published packages include pykotor, holopatcher, holocrontoolset, and kotordiff. [PyKotor pyproject.toml, HoloPatcher pyproject.toml, Holocron Toolset pyproject.toml, KotorDiff pyproject.toml]

The Markdown pages in this directory are also bundled into Holocron Toolset help output under src/toolset/help/wiki, so the wiki is part of the packaged toolchain rather than a separate website-only manual. [Holocron Toolset MANIFEST.in, Holocron Toolset pyproject.toml]

In-repo components

• PyKotor is the core library and CLI foundation for extraction, resource typing, and format parsing and writing; the implementation surface starts in pykotor.extract, pykotor.resource.type, and pykotor.resource.formats, and the corresponding reference pages begin with Concepts, Resource-Formats-and-Resolution, Container-Formats, 2DA-File-Format, GFF-File-Format, Audio-and-Localization-Formats, Texture-Formats, Level-Layout-Formats, MDL-MDX-File-Format, NCS-File-Format, NSS-File-Format, and LTR-File-Format. [pykotor.extract.installation, pykotor.resource.type, pykotor.resource.formats, PyKotor pyproject.toml]
• HoloPatcher is the cross-platform TSLPatcher-compatible installer layer; its GUI and CLI entry points live in holopatcher.app and holopatcher.cli, while the patch configuration and apply pipeline live in pykotor.tslpatcher.reader, pykotor.tslpatcher.patcher, and pykotor.tslpatcher.writer, which is why the relevant pages are Installing-Mods-with-HoloPatcher, HoloPatcher, HoloPatcher-README-for-mod-developers, Explanations-on-HoloPatcher-Internal-Logic, and the TSLPatcher syntax references. [HoloPatcher pyproject.toml, holopatcher/app.py, holopatcher/cli.py, pykotor.tslpatcher.reader, pykotor.tslpatcher.patcher, pykotor.tslpatcher.writer]
• Holocron Toolset is the PyQt-backed GUI editing suite, and its package metadata declares the main application together with standalone editors for ARE, BWM, DLG, ERF, GFF, GIT, IFO, JRL, LIP, LTR, MDL, and other resource families; the relevant pages are Holocron-Toolset-Getting-Started, Holocron-Toolset-Core-Resources, Holocron-Toolset-Module-Resources, Holocron-Toolset-Map-Builder, Indoor-Map-Builder-User-Guide, Indoor-Map-Builder-Implementation-Guide, Holocron-Toolset-Module-Editor, and Qt-ItemView-Selection-and-RobustTableView. [Holocron Toolset pyproject.toml, toolset.gui.editors.standalone, Holocron Toolset MANIFEST.in]
• KotorDiff is the diff and patch-data generation layer, and the standalone kotordiff package is a shim over pykotor.diff_tool, whose source tree contains the CLI, application, differ, merge, and logging modules; the relevant page is KotorDiff-Integration. [KotorDiff pyproject.toml, pykotor.diff_tool.__init__, pykotor.diff_tool.app]

External corroboration repositories

• xoreos is a BioWare Aurora and Odyssey engine reimplementation, and its source tree includes dedicated KotOR and KotOR II engine directories under src/engines/kotor and src/engines/kotor2. [xoreos README, KotOR engine tree, KotOR II engine tree]
• xoreos-tools is the companion CLI and tooling repository, and its tree includes developer utilities such as gff2xml. [xoreos-tools README, gff2xml man page]
• xoreos-docs is the xoreos format-spec repository, and its README explicitly lists official BioWare documents, Torlack notes, and a partial kotor_mdl.html specification. [xoreos-docs README]
• reone is a C++ engine focused on KotOR and TSL. [reone README]
• KotOR.js is a TypeScript reimplementation of the Odyssey engine and includes the KotOR Forge modding suite. [KotOR.js README]
• Kotor.NET is a C# solution whose repository root contains the core Kotor.NET library together with Kotor.NET.Graphics, Kotor.NET.Patcher, Toolset, and MapBuilder projects. [Kotor.NET repository root, Kotor.NET solution]
• bioware-kaitai-formats is an OpenKotOR repository for BioWare, KotOR, and TSL Kaitai Struct definitions, and Kaitai Struct defines .ksy files as declarative binary format specifications that compile into parsers for multiple languages. [bioware-kaitai-formats, Kaitai Struct]
• KotorMCP is an OpenKotOR MCP server that exposes installation discovery, resource inspection, and PyKotor-backed analysis workflows for KotOR and TSL. [KotorMCP README]

Page families

• Runtime and format reference: Concepts, Resource-Formats-and-Resolution, Container-Formats, 2DA-File-Format, GFF-File-Format, Audio-and-Localization-Formats, Texture-Formats, Level-Layout-Formats, MDL-MDX-File-Format, NCS-File-Format, NSS-File-Format, and LTR-File-Format.
• Installer and patch-data workflows: Installing-Mods-with-HoloPatcher, HoloPatcher, HoloPatcher-README-for-mod-developers, KotorDiff-Integration, TSLPatcher-Data-Syntax, TSLPatcher-GFF-Syntax, TSLPatcher-Install-and-Hack-Syntax, and TSLPatcher's-Official-Readme.
• Toolset and editor workflows: Holocron-Toolset-Getting-Started, Holocron-Toolset-Core-Resources, Holocron-Toolset-Module-Resources, Holocron-Toolset-Module-Editor, Holocron-Toolset-Map-Builder, Indoor-Map-Builder-User-Guide, Indoor-Map-Builder-Implementation-Guide, and Qt-ItemView-Selection-and-RobustTableView.
• Reverse engineering and preserved-source material: reverse_engineering_findings, its archive pages, Bioware-Aurora-Core-Formats, Bioware-Aurora-Module-and-Area, Bioware-Aurora-Creature, Bioware-Aurora-Items-Economy-and-Narrative, Bioware-Aurora-Spatial-and-Interactive, and Bioware-Aurora-Conversation.