With KCDS, you can run a multiplayer server for Kingdom Come: Deliverance II and extend it with resources. These pages are
the public documentation, published at https://kcdsynced.com/docs along with the API reference generated from the runtimes.
They cover how to use KCDS, not how it is built. All pages are in English, and links to API pages are written
/docs/api/<type>.
Found a mistake or something unclear? Open an issue or a pull request in this repository. The text is CC BY-ND 4.0 and the code examples are free to use in your resources (MIT-0): see LICENSE.md.
- Getting started, Your first resource
- Project structure, TypeScript,
- Project structure, TypeScript, Lua, C#, Trying code quickly, Debugging resources
- Writing resources with an AI assistant: CLAUDE.md for Claude Code, CODEX.md for Codex
and assistants that read
AGENTS.md
- Running a server, Containers, How players connect, Join queue and whitelist
- Server rules, A legal copy of the game
- Discord presence
- Resources, Client resources, API overview, API changes
- Events, Actions and their phases, Imports and exports, Messages
- Shared state, Chat and translated texts
- Timers, logging and the runtime, Math types
- Players, Restricting a player, Carrying and attaching players
- Skills, perks and needs, Custom perks, Custom buffs
- Animations, Nameplates, Voice chat, Following someone
- Time, weather and the world, Lights, Particle effects
- Areas, Markers and blips
- Felling trees, Editing the level
- Inventory and items, Equipment
- Quests and conversations, Shops and player trade
- Crafting, cooking and gathering, Dice and pickpocketing, Tabletop games
- HUD and messages, "Press [key] to ..." hints, Books and letters, Map and compass, Shooting contests and races, Cutscenes and the character's remarks
- Web views, The game's own interface
- Keys and controls, Camera, What the player looks at, Pictures from any camera, Character creator, Local NPCs and the local player
- Sounds and game files