Skip to content

Commit 5a940ce

Browse files
Qubus0KANAjetzt
andauthored
docs: correct readme and add features list (#477)
* correct readme and add features list * Update README.md Co-authored-by: KANAjetzt <41547570+KANAjetzt@users.noreply.github.com> --------- Co-authored-by: KANAjetzt <41547570+KANAjetzt@users.noreply.github.com>
1 parent 7fdb894 commit 5a940ce

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

README.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,47 @@ A generalized Mod Loader for GDScript-based Godot games.
1212
The Mod Loader allows users to create mods for games and distribute them as zips.
1313
Importantly, it provides methods to change existing scripts, scenes, and resources without modifying and distributing vanilla game files.
1414

15+
## Features
16+
- Loading ZIPs as mods into the running game
17+
- Makes every script and resource moddable
18+
- Vanilla game files are not shared in mods
19+
- Disabled mods leave no trace
20+
- since Godot 4: workaround to mod scripts using `class_name`
21+
- Mod metadata
22+
- Compatibility checks between game and mod version
23+
- Load order/dependencies between mods
24+
- General info like author and version
25+
- Mod Configs
26+
- Settings for each individual mod
27+
- Mod Profiles
28+
- Lists of mods and configurations that can easily be enabled and disabled
29+
- Unified logging system for mods
30+
- Mod Loader Options
31+
- allowing different Mod Loader settings per-feature
32+
- Built in Mod Sources:
33+
- Steam Workshop
34+
- Thunderstore
35+
- Local /mods folder
36+
- Self Setup for mods that don't have the Mod Loader preinstalled
37+
1538
## Getting Started
1639

17-
You can find detailed documentation, for game and mod developers, on the [Wiki](https://github.com/GodotModding/godot-mod-loader/wiki/) page.
40+
You can find detailed documentation, for game and mod developers, on the [Wiki](https://wiki.godotmodding.com/) page.
1841

19-
1. Add ModLoader to your [Godot Project](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup)
42+
1. Add ModLoader to your [Godot Project](https://wiki.godotmodding.com/guides/integration/godot_project_setup/)
2043
*Details on how to set up the Mod Loader in your Godot Project, relevant for game and mod developers.*
21-
2. Create your [Mod Structure](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Structure)
44+
2. Create your [Mod Structure](https://wiki.godotmodding.com/guides/modding/mod_structure/)
2245
*The mods loaded by the Mod Loader must follow a specific directory structure.*
23-
3. Create your [Mod Files](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files)
46+
3. Create your [Mod Files](https://wiki.godotmodding.com/guides/modding/mod_files/)
2447
*Learn about the required files to create your first mod.*
25-
4. Use the [API Methods](https://github.com/GodotModding/godot-mod-loader/wiki/ModLoader-API)
48+
4. Use the [API Methods](https://wiki.godotmodding.com/api/mod_loader_api/)
2649
*A list of all available API Methods.*
2750

2851
## Godot Version
29-
The current version of the Mod Loader is developed for Godot 3.5. We have not yet ported it to Godot 4.0 due to lack of demand. If you require support for Godot 4.0, please let us know by opening an [issue](https://github.com/GodotModding/godot-mod-loader/issues) or joining [our Discord](https://discord.godotmodding.com).
52+
The current version of the Mod Loader is developed for Godot 3.
53+
The Godot 4 version is nearing release on the [4.x branch](https://github.com/GodotModding/godot-mod-loader/tree/4.x).
54+
For more details and updates on the Godot 4 version, please follow this [issue](https://github.com/GodotModding/godot-mod-loader/issues/315)
55+
or join us on [our Discord](https://discord.godotmodding.com).
3056

3157
## Development
3258
The latest work-in-progress build can be found on the [development branch](https://github.com/GodotModding/godot-mod-loader/tree/development).

0 commit comments

Comments
 (0)