Crusader Kings 3 Modding Documentation

A git-versioned archive of the official Crusader Kings 3 modding documentation from the Paradox Wiki.

![npm version](https://www.npmjs.com/package/ck3-modding-wiki)
![update](https://github.com/jesec/ck3-modding-wiki/actions/workflows/update.yml)

📚 Complete Table of Contents - Comprehensive index of all pages and sections

About This Repository

This repository contains complete modding documentation for Crusader Kings 3, converted to Markdown format for easy reading, searching, and offline access. All content is sourced from the official Paradox Wiki and is maintained as a reference for mod developers.

Automatically updated daily via GitHub Actions to stay in sync with the official wiki.

Quick Start

New to CK3 modding? Start here:
- Modding - Introduction and essential guidelines
- Mod Structure - How to organize your mod files
- Scripting - Core scripting concepts
- Modding Tools - Recommended tools and utilities

Having issues? Check:
- Mod Troubleshooting - Common problems and solutions

Documentation Index

$3

- Modding - Overview and tips for CK3 modding
- Mod Structure - File organization and mod setup
- Mod Troubleshooting - Debugging and common issues
- Modding Tools - Text editors, validators, and utilities

$3

- Scripting - Scripting fundamentals
- Data Types - Understanding data types in CK3
- Scopes - Scope concepts and usage
- Scopes List - Complete scope reference
- Variables - Using and manipulating variables
- Weight Modifier - Weighted random selection

$3

- Effects - How to use effects
- Effects List - Complete effects reference
- Triggers - Conditional logic
- Triggers List - Complete triggers reference
- Scripted Effects - Creating reusable effects

$3

#### Characters & Dynasties
- Characters Modding - Character traits, attributes, and systems
- Dynasties Modding - Dynasty creation and management
- Trait Modding - Creating and modifying character traits

#### Governments & Titles
- Governments Modding - Government types and mechanics
- Title Modding - Titles, ranks, and succession
- Council Modding - Council positions and tasks
- Holdings Modding - Baronies and holdings

#### Religion & Culture
- Religions Modding - Faiths, doctrines, and holy orders
- Culture Modding - Cultural traditions and innovations

#### Events & Decisions
- Event Modding - Creating events and event chains
- Decisions Modding - Adding player decisions
- Interactions Modding - Character interactions

#### Advanced Systems
- Artifact Modding - Creating artifacts and relics
- Story Cycles Modding - Story event systems
- Struggle Modding - Regional struggle mechanics

$3

#### Graphics
- Graphical Assets - Sprites, textures, and visual assets
- 3D Models - Character and object models
- Coat of Arms Modding - Heraldry and emblems
- Interface - UI and GUI modding
- Fonts - Font configuration

#### Audio
- Music Modding - Background music and themes
- Sound Modding - Sound effects and audio

$3

- Map Modding - Creating and editing the game map
- Terrain Modding - Terrain types and properties
- History Modding - Historical setups and bookmarks
- Bookmarks Modding - Start dates and scenarios

$3

- Regiments Modding - Unit types and military units

$3

- Localization - Translating and text formatting
- Flavorization - Dynamic text and name generation

$3

- Commands - Script commands reference
- Console Commands - Debug console commands
- Defines - Global game constants
- Lists - Various reference lists
- Modifier List - All available modifiers

$3

- Exporters - Data export tools

How to Use This Documentation

1. Browse by Topic: Use the index above to find documentation for specific modding areas
2. Search: Use your editor's search functionality to find keywords across all files
3. Cross-Reference: Pages contain links to related topics (may need conversion to work locally)
4. XML Source: Original MediaWiki XML exports are available in wiki_exports/ for reference

File Organization

``ck3-modding-wiki/ ├── wiki_pages/ # Markdown documentation (read these) │ ├── Modding.md │ ├── Event_modding.md │ └── ... ├── assets/ # Images and icons from the wiki │ ├── icons/ # Modifier icons (72 files) │ └── images/ # Documentation images (65+ files) └── wiki_exports/ # Original XML exports (reference only) ├── Modding.xml └── ...`

All images are bundled locally. Markdown files reference images using relative paths like !caption.

`Versioning`

This package uses date-based versioning: {major}.YYYYMMDD.{patch}

Example: 1.20251103.0 = Major version 1, snapshot from November 3, 2025, patch 0

Automatically updated daily via GitHub Actions.

`Development`

To update the documentation from the wiki:

`bash

`Full update (downloads wiki pages + assets, then converts)`


npm run update
Individual commands

npm run download         # Download wiki pages and assets
npm run download-assets  # Download only assets
npm run convert          # Convert XML to Markdown

Contributing

This is an archived reference repository. The canonical source is the CK3 Paradox Wiki. To contribute improvements to the documentation itself, please edit the wiki directly.

If you find conversion bugs (tables, code blocks, etc.), please open an issue or submit a PR.

External Resources

- Official Wiki: https://ck3.paradoxwikis.com/Category:Modding
- CK3 Modding Discord: https://discord.com/invite/apEvxDZ
- Paradox Mods: https://mods.paradoxplaza.com/games/ck3
- Steam Workshop: https://steamcommunity.com/app/1158310/workshop/
- Paradox Forums: https://forum.paradoxplaza.com/forum/forums/crusader-kings-iii.1046/

License

$3

All wiki content is published under the Creative Commons Attribution-Share Alike 3.0 license. Content may be copied and adapted provided that:
- Attribution and link to the CK3 Paradox Wiki is included
- Derivative works are published under an equivalent license

$3

This repository makes use of content from Crusader Kings III published by Paradox Interactive. Copyright to such content is held by Paradox Interactive AB or its subsidiary Paradox Development Studio.