Skip to content

Commit

Permalink
chore: 📝 updated readme with more details (#284)
Browse files Browse the repository at this point in the history
* chore: 📝 updated readme with more details

closes #180

* chore: 📝 moved "Godot Version" section down
  • Loading branch information
KANAjetzt authored Jun 21, 2023
1 parent 0434f74 commit 97de024
Showing 1 changed file with 34 additions and 6 deletions.
40 changes: 34 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
<div align="center">

# GDScript Mod Loader

A general purpose mod-loader for GDScript-based Godot Games.
<img alt="Godot Modding Logo" src="https://github.com/KANAjetzt/godot-mod-loader/assets/41547570/44df4f33-883e-4c1d-baac-06f87b0656f4" width="256" />

</div>

<br />

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

0 comments on commit 97de024

Please sign in to comment.