Skip to content

Home

Jump to bottom
Camille Baillat edited this page Feb 17, 2022 · 3 revisions

Welcome to the awesome-ck3 wiki

This wiki will focus on helping modders get into CK3 modding. I will try to centralize all existing documentation. Maybe in the future I will help contribute to the official modding wiki, but I need to look into how to edit and had to the official CK3 wiki.

Goals

Main goals

  • templates: folders to copy/paste and start modding with helpful comments in the files
    • mod with picture, version and all fields documented (requirements for the picture, the version syntax, etc.)
    • a template for each modding aspect (add a trait, edit an event, add an interaction, edit the GUI, etc)
  • guides: how to make various simple changes and document the various scopes and variables in the CK3 engine. This will be a pragmatical approach on how to do things, and maybe a reference document in the future for all variables and scopes
    • add a trait, genetic, inheritable, or not
    • add a lifestyle tree
    • add a GUI button
  • advice with mod merges

In the far future

  • mod generator: generate necessary files for each template and ask for input (name, author, picture, mod type...)
  • mod framework: framework for easy compatibility between mods (a trait framework, a lifestyle framework, a UI framework...). The goal is that modders could easily know which mods are compatible and which would require a deep merge.
  • merge tool: create a tool or improve Irony Mod Manager to help with merge incompatible mods (diff view, advices, etc)

Contents

Scripting

This tutorial will show the basics of scripting. The content is based on the two guides provided by Caden335#9328: Scripting_in_CK3_Guide and GUI_Modding_guide. The files themselves are backed-up in the backup folder in case they stop being available in the Discord server.

For now, I'm following those two guides and simply converting them to the markdown format. Later, I will make it a more interactive tutorial by showing the concepts by making a simple mod.

Useful links

You can check the awesome-ck3 list for more resources on modding and scripting.

Credits

I'd like to thank the entire CK3 modding community for providing as many resources as they can for a very sparsely documented project.

Some content is based on the two guides provided by Caden335#9328: Scripting_in_CK3_Guide and GUI_Modding_guide.

The files themselves are backed-up in case they stop being available in the Discord server:

Clone this wiki locally