From 97de024087fcd5ff278e0b23085d733d8d209fcd Mon Sep 17 00:00:00 2001 From: KANAjetzt <41547570+KANAjetzt@users.noreply.github.com> Date: Wed, 21 Jun 2023 09:46:19 +0200 Subject: [PATCH] chore: :memo: updated readme with more details (#284) * chore: :memo: updated readme with more details closes #180 * chore: :memo: moved "Godot Version" section down --- README.md | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0c321580..d2d12511 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,40 @@ +
+ # GDScript Mod Loader -A general purpose mod-loader for GDScript-based Godot Games. +Godot Modding Logo + +
+ +
+ +A generalized Mod Loader for GDScript-based Godot games. +The Mod Loader allows users to create mods for games and distribute them as zips. +Importantly, it provides methods to change existing scripts, scenes, and resources without modifying and distributing vanilla game files. ## Getting Started -View the [Wiki](https://github.com/GodotModding/godot-mod-loader/wiki/) for more information. +You can find detailed documentation, for game and mod developers, on the [Wiki](https://github.com/GodotModding/godot-mod-loader/wiki/) page. + +1. Add ModLoader to your [Godot Project](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup) + *Details on how to set up the Mod Loader in your Godot Project, relevant for game and mod developers.* +2. Create your [Mod Structure](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Structure) + *The mods loaded by the Mod Loader must follow a specific directory structure.* +3. Create your [Mod Files](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files) + *Learn about the required files to create your first mod.* +4. Use the [API Methods](https://github.com/GodotModding/godot-mod-loader/wiki/ModLoader-API) + *A list of all available API Methods.* + +## Godot Version +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. + +## Development +The latest work-in-progress build can be found on the [development branch](https://github.com/GodotModding/godot-mod-loader/tree/development). -1. Add ModLoader to your [Godot Project](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup). -1. Create your [Mod Structure](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Structure) -1. Create your [Mod Files](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files) -1. Use the [API Methods](https://github.com/GodotModding/godot-mod-loader/wiki/API-Methods) +## Compatibility +The Mod Loader supports the following platforms: +- Windows +- macOS +- Linux +- Android +- iOS