ck3-mods/awesome-ck3

This repository will be two things: a list of resources for CK3 modding and a wiki to help with practical modding

Awesome CK3

A list of resources for modding CK3 as well as a wiki to help CK3 modding

• Wiki
• Communities
• Help
  • Documentation
  • Guides and tutorials
    • General advice
    • Events
    • UI
    • 3D modeling
    • Videos
• Software and applications
  • Mod management
  • Graphical modding
  • Other Tools
• Contribute

Wiki

⚠⚠️ ️Actual documentation and guides for this project and for CK3 will be available in the project's wiki. ⚠️ ⚠️

Communities

You can find help and fellow modders in theses places.

• CK3 User Mods: official forum for CK3 mods
• Crusader Kings: Crusader Kings official Discord modding channel. Go to the server-roles channel and choose CK3 Modding in the Channel Access post
• CK3 Mod Co-op: this discord is where you can recruit people for your mod, show off stuff, and ask modders for help when you need it. It also serves as a central hub for modding in CK3. You can find invite links to most large mods on it.

Help

Documentation

These are official and unofficial documentation about the CK3 script language.

• CK3 reference: a list of Crusader Kings III triggers, modifiers, effects, etc. Very useful to have more details on a specific variable in CK3 modding
• Effects: Official CK3 Paradox wiki page for Effects
• Modifier list: Official CK3 Paradox wiki page for Modifier lists
• Scopes: Official CK3 Paradox wiki page for Scopes
• Triggers: Official CK3 Paradox wiki page for Triggers

Guides and tutorials

These resources will guide you through CK3 modding.

General advice

• Dev diary #37: an official dev diary on mod making: mod compatibility, character interaction, scripted GUI, and notifications
• Jomini information thread: information about Jomini, the shared Clausewitz engin library. Useful to understand broadly how scopes, events and other stuff works
• CK3 quick start to Modding: a quick and dirty guide to CK3 modding, quite minimalistic but with links to a few tutorial videos

Events

• Event modding: official event modding guide on the CK3 wiki
• Dev diary #30: an official dev diary on event scripting

UI

• Unified UI CK3: the most imprtant to check is the wiki, with a lot of good advices on how to make your UI modifications compatible with most mods

3D modeling

• Creating a 3D model: this tutorial is for Imperator but most of it applies for CK3

Videos

For those who prefer a visual help.

• Brief introduction to modding: don't forget to check the description, there are some useful links and tools

Software and applications

Useful tools and applications for modding or mod management.

Mod management

• Irony Mod Manager: an alternative to the official Paradox Launcher. Doesn't support mod analysis yet, but it's on the roadmap. Warning: Use one or the other to avoid conflicts

Graphical modding

• Mayan and Photoshop exporters: exporter tools that Paradox provides 'as-is'. These can be used to export textures from Photoshop and meshes/animations from Maya. More documentation can be found on the Stellaris wiki
• Mesh editor for Blender and Maya: allow editing of mesh and animation files used in the various Clausewitz Engine games in both Maya and Blender
• Chasm Terrain Shader: this is a chasm brush for the CK3 map editor. Could also be useful if you want to learn how to mod your own brushes :)

Other Tools

• CWTools: a syntax analysis tool that can be used in IDE (VSCode) or some custom projects (used in Irony Mod Manager for example)
• PDX Unlimiter: a save editing software for Paradox games. Raw CK3 save editing is supported though advanced and more fancy editing GUI tools are still to come
• CK3 ML Translator: a python 3.9 module to translate all localisation files for Crusader Kings 3 mods

Contribute

Contributions welcome! Read the contribution guidelines first.