DOCSEARCHbyAlgolia
Submit Docs

GDScript Mod Loader

repository·4.x-dev·Indexed 20 days ago

https://github.com/godotmodding/godot-mod-loader

A generalized modding framework for GDScript-based Godot 3.x and 4.x games. It enables non-destructive modification of scripts, scenes, and resources by loading mods as ZIP files at runtime. Features include mod metadata for compatibility and dependencies, mod profiles, config settings, and built-in support for Steam Workshop, Thunderstore, and local folders.

Tokens
381
Snippets
0
Records
2
Agent score
21%

What's inside godot-mod-loader

  1. Overview of GDScript Mod Loader

    4.x-dev

    GDScript Mod Loader is a generalized modding framework for Godot games. It allows developers to make their games moddable by providing a system to load ZIP files as mods at runtime.

    Key capabilities include:

    • Non-destructive modding: Change existing scripts, scenes, and resources without modifying the original vanilla game files.
    • Mod Metadata: Supports compatibility checks (game vs. mod version), load order/dependencies, and general info (author, version).
    • Mod Management: Includes support for Mod Configs (per-mod settings), Mod Profiles (sets of enabled/disabled mods), and a unified logging system.
    • Built-in Sources: Automatically supports Steam Workshop, Thunderstore, and a local /mods folder.
    • Self-Setup: Can be used for mods even if the game does not have the Mod Loader pre-installed.

  2. Install GDScript Mod Loader for Godot 3 or 4

    4.x-dev

    Depending on your Godot version, you can obtain the Mod Loader via the official releases or the Godot Asset Library:

    Godot 3.x

    Godot 4.x

    For development purposes, work-in-progress builds are available on the 3.x-dev and 4.x-dev branches respectively.