Skip to content

Commit 2ee001d

Browse files
Update README.md
1 parent 75f6e88 commit 2ee001d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
## What is this?
22
This is the example mod for ValksGodotTools/Template. Mods can add and replace assets as well as execute C# scripts.
33

4+
> [!CAUTION]
5+
> In order to execute scripts across several mods properly, [this issue](https://github.com/ValksGodotTools/Template/issues/15) needs to get resolved. In the meantime mods adding scripts to mods should be avoided.
6+
47
> [!WARNING]
58
> Every mod needs a `mod.json` file. The `id` should be unique to your mod and only your mod.
69
```json
@@ -43,3 +46,11 @@ public partial class Mod : Node
4346
```
4447
> [!NOTE]
4548
> The `Mod` node will get added as a child when the mod loads in, so any built-in node functions like `_Ready()` and `_PhysicsProcess()` will act as the entry point to your mod.
49+
50+
## Exporting the Mod
51+
1. Export the mod via `Project > Export...`
52+
2. Create a new folder for your mod. The mod should contain at least 3 files.
53+
- `mod.json` *(the file you created earlier)*
54+
- `mod.pck` *(generated from the export)*
55+
- `Mod.dll` *(generated inside `.godot\mono\temp\bin\Debug`)*
56+
3. Put this folder inside the `Mods/` folder of the game

0 commit comments

Comments
 (0)