search

GodotModding / godot-mod-loader

A general purpose mod loader for GDScript based Godot Games [3.x/4.x]
https://discord.godotmodding.com
Creative Commons Zero v1.0 Universal
366 stars 30 forks source link
godot godot-modding mod-loader

readme

# GDScript Mod Loader 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

You can find detailed documentation, for game and mod developers, on the Wiki page.

  1. Add ModLoader to your Godot Project
    Details on how to set up the Mod Loader in your Godot Project, relevant for game and mod developers.
  2. Create your Mod Structure
    The mods loaded by the Mod Loader must follow a specific directory structure.
  3. Create your Mod Files
    Learn about the required files to create your first mod.
  4. Use the API Methods
    A list of all available API Methods.

Godot Version

The current version of the Mod Loader is developed for Godot 3. The Godot 4 version is in progress on the 4.x branch and can be used as long as no class_names are in the project. Projects with class_names are currently affected by an engine bug. We are hopeful that this issue will be resolved in the near future. For more details and updates on the Godot 4 version, please follow this issue or join us on our Discord.

Development

The latest work-in-progress build can be found on the development branch.

Compatibility

The Mod Loader supports the following platforms:

Games Made Moddable by This Project