Skip to content

Commit 97de024

Browse files
authored
chore: 📝 updated readme with more details (#284)
* chore: 📝 updated readme with more details closes #180 * chore: 📝 moved "Godot Version" section down
1 parent 0434f74 commit 97de024

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
1+
<div align="center">
2+
13
# GDScript Mod Loader
24

3-
A general purpose mod-loader for GDScript-based Godot Games.
5+
<img alt="Godot Modding Logo" src="https://github.com/KANAjetzt/godot-mod-loader/assets/41547570/44df4f33-883e-4c1d-baac-06f87b0656f4" width="256" />
6+
7+
</div>
8+
9+
<br />
10+
11+
A generalized Mod Loader for GDScript-based Godot games.
12+
The Mod Loader allows users to create mods for games and distribute them as zips.
13+
Importantly, it provides methods to change existing scripts, scenes, and resources without modifying and distributing vanilla game files.
414

515
## Getting Started
616

7-
View the [Uncyclo](https://github.com/GodotModding/godot-mod-loader/wiki/) for more information.
17+
You can find detailed documentation, for game and mod developers, on the [Uncyclo](https://github.com/GodotModding/godot-mod-loader/wiki/) page.
18+
19+
1. Add ModLoader to your [Godot Project](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup)
20+
*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)
22+
*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)
24+
*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)
26+
*A list of all available API Methods.*
27+
28+
## 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 or joining our Discord.
30+
31+
## Development
32+
The latest work-in-progress build can be found on the [development branch](https://github.com/GodotModding/godot-mod-loader/tree/development).
833

9-
1. Add ModLoader to your [Godot Project](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup).
10-
1. Create your [Mod Structure](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Structure)
11-
1. Create your [Mod Files](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files)
12-
1. Use the [API Methods](https://github.com/GodotModding/godot-mod-loader/wiki/API-Methods)
34+
## Compatibility
35+
The Mod Loader supports the following platforms:
36+
- Windows
37+
- macOS
38+
- Linux
39+
- Android
40+
- iOS

0 commit comments

Comments
 (0)