Skip to content

GodotModding/godot-mod-loader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.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.

Compatibility

The Mod Loader supports the following platforms:

  • Windows
  • macOS
  • Linux
  • Android
  • iOS