Modding Intro and Rules

Welcome, Mod Developer!

Your creativity adds a vibrant and exciting dimension to Dome Keeper. By decompiling the game and using it to develop a mod, you are agreeing to our Modding End User License Agreement (EULA) and the following guidelines. Let's cultivate a thriving and safe modding community together.

⚠ You are allowed to use the decompiled project for developing your mods if you accept the following rules ⚠

❗ The distribution of Dome Keeper in its binary or decompiled forms, including the pck, is prohibited.

❗ When sharing your mods source code make sure to only include your modded files and not include original game files. Use a proper .gitignore file to assist with this.

❗ The Dome Keeper source code and/or assets are to be used exclusively for creating mods for Dome Keeper.

❗ Creation of Dome Keeper versions for other platforms, such as homebrew, mobile, etc., is not allowed.

❗ Your mods should be free from any form of malware, hacks, or advertisements.

❗ While we encourage creativity, remember that mods must not be commercialized or used for financial gain. However, you are allowed to accept donations for your time through platforms like Patreon, or through sponsorships.

❗ If you do not want to agree to our Modding End User License Agreement (EULA) or the guidelines above, decompiling or modding Dome Keeper is not allowed.

By adhering to these guidelines, we can ensure a respectful and enjoyable modding experience for all Dome Keeper fans.

Thank you, and happy modding!

---

Prerequisites

To start modding, ensure you have:

• Dome Keeper on Steam.
• Downloaded GodotSteam 4.2.2. Depending on your OS one of linux64, macos, win32, or win64
• Downloaded the latest version of GDRETools from their GitHub repo's releases section.
• Read the Guide for Players for understanding how mods are used.

🔧 Decompiling using GDRETools

The initial step is to decompile the game using GDRETools.

1. Launch GDRETools
2. Select RE Tools > Recover Project.

3. Find the Dome Keeper folder and choose the domekeeper.pck file, which you can find at ...\Steam\steamapps\common\Dome Keeper\domekeeper.pck.
4. A short loading bar will follow, and then a PCK Explorer popup will appear. Ensure the checkbox at res:// is checked, select Full Recovery, and choose a destination folder.

5. Once a longer loading bar concludes, the decompilation process is finished. You can now close GDRETools and the final report.

Opening the Project in Godot

Post-decompilation, initiate the Godot Engine and import the decompiled game to commence mod development.

Godot Engine and GodotSteam

🚨 Important: Dome Keeper is developed using GodotSteam, a forked version of the Godot Engine with Steam API support. The standard Godot Engine lacks the tools necessary for Steam interfacing. In newer versions of the game, running it through the non-Steam version of the editor will work, but you won't be able to upload your mod to the workshop with it.

To open your newly decompiled project, launch GodotSteam and click Import.

Subsequently, locate the project.godot file in the destination folder where you decompiled the pck file. Click Open followed by Import & Edit.

The project will now launch, though this may take some time initially.

Starting the Game

Once the project is open in Godot, you can run the project at any time by clicking the arrow located in the top right corner.

Alternatively, you can press F5 (or the hotkey shown when hovering the play button) to run the project.

Translation Server fix

Post-decompilation, the project's translation files may experience issues, which could lead to console errors or display text abnormalities in the game.

To correct this, locate the FixCsv.tscn file in Godot's File System (usually found in the lower left corner of the Godot Engine window).

Open the scene by double-clicking it and initiate it by clicking the Play Scene button in the top right, or by pressing F6.

After a brief moment, the operation should complete, and the translations will be fixed.

Next Step

✨ Your first Mod