Crypt of the NecroDancer: Synchrony Modding Documentation¶
Playing mods¶
Full Lua modding support was introduced in Crypt of the NecroDancer: Synchrony, available on Steam and GOG.
Once Synchrony is installed, you can open the mod browser via the game's "Customize" menu, under the option "Mods". From there, you can see a selection of popular mods from mod.io, as well as an option to browse the full list of mods.
Unlike mods for previous versions of the game (now called "Resource Packs"), Synchrony mods can alter gameplay significantly, adding new player characters, enemies, items, traps, bosses, shrines, tiles or game modes, as well as just about any game mechanic imaginable.
Mods can be toggled on or off at any time without restarting the game (or even interrupting an in-progress run), are compatible with online multiplayer lobbies by default, and will automatically synchronize between players when joining online sessions.
Creating mods¶
If you're already familiar with Lua and would like to familiarize yourself with how NecroDancer uses the language in its modding API, the Synchrony Lua scripting overview describes the various systems available for use in mods.
If you're new to Lua or modding in general, here are some guides written by our community to help you get started:
- NecroDancer Mod Guide by yuka
- Introduction to Crypt of the Necrodancer: Synchrony modding by Danizk0
If you get stuck or need more specific advice, feel free to join our Discord server.
This is where most discussions related to mod creation take place, and you can search for your problem or ask for help
in the #mod-help channel.