Skip to content

Commit 1026eca

Browse files
Merge pull request #57 from ithinkandicode/readme-basic-v2
README - Migrate content to wiki
2 parents 2e3e46e + 9ed15a2 commit 1026eca

File tree

1 file changed

+6
-63
lines changed

1 file changed

+6
-63
lines changed

README.md

Lines changed: 6 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,11 @@
22

33
A general purpose mod-loader for GDScript-based Godot Games.
44

5-
See the [Uncyclo](https://github.com/GodotModding/godot-mod-loader/wiki) for additional details, including [Helper Methods](https://github.com/GodotModding/godot-mod-loader/wiki/Helper-Methods) and [CLI Args](https://github.com/GodotModding/godot-mod-loader/wiki/CLI-Args).
5+
## Getting Started
66

7+
View the [Uncyclo](https://github.com/GodotModding/godot-mod-loader/wiki/) for more information.
78

8-
## Mod Setup
9-
10-
For more info, see the [docs for Delta-V Modding](https://gitlab.com/Delta-V-Modding/Mods/-/blob/main/MODDING.md), upon which ModLoader is based. The docs there cover mod setup in much greater detail.
11-
12-
### Structure
13-
14-
Mod ZIPs should have the structure shown below. The name of the ZIP is arbitrary.
15-
16-
```
17-
yourmod.zip
18-
├───.import
19-
└───mods-unpacked
20-
└───Author-ModName
21-
├───mod_main.gd
22-
└───manifest.json
23-
```
24-
25-
#### Notes on .import
26-
27-
Adding the .import directory is only needed when your mod adds content such as PNGs and sound files. In these cases, your mod's .import folder should **only** include your custom assets, and should not include any vanilla files.
28-
29-
You can copy your custom assets from your project's .import directory. They can be easily identified by sorting by date. To clean up unused files, it's helpful to delete everything in .import that's not vanilla, then run the game again, which will re-create only the files that are actually used.
30-
31-
32-
### Required Files
33-
34-
Mods you create must have the following 2 files:
35-
36-
- **mod_main.gd** - The init file for your mod.
37-
- **manifest.json** - Meta data for your mod (see below).
38-
39-
#### Example manifest.json
40-
41-
```json
42-
{
43-
"name": "ModName",
44-
"namespace": "AuthorName",
45-
"version_number": "1.0.0",
46-
"description": "Mod description goes here",
47-
"website_url": "https://github.com/example/repo",
48-
"dependencies": [
49-
"Add IDs of other mods here, if your mod needs them to work"
50-
],
51-
"extra": {
52-
"godot": {
53-
"incompatibilities": [
54-
"Add IDs of other mods here, if your mod conflicts with them"
55-
],
56-
"authors": ["AuthorName"],
57-
"compatible_mod_loader_version": "3.0.0",
58-
"compatible_game_version": ["0.6.1.6"],
59-
"config_defaults": {}
60-
}
61-
}
62-
}
63-
```
64-
65-
## Credits
66-
67-
🔥 ModLoader is based on the work of these brilliant people 🔥
68-
69-
- [Delta-V-Modding](https://gitlab.com/Delta-V-Modding/Mods)
9+
1. Add ModLoader to your [Godot Project](Godot-Project-Setup).
10+
1. Create your [Mod Structure](Mod-Structure)
11+
1. Create your [Mod Files](Mod-Files)
12+
1. Use the [API Methods](API-Methods)

0 commit comments

Comments
 (0)