Skip to content

Installation

Requirements

  • Godot Engine: 4.6 or higher

📦 Step 1: Get the Plugin Files

Choose one of the following methods to add the plugin files to your project.

Method A: Godot Asset Library (Easiest)

Option 1: Via the Godot Editor

  1. Open your project in the Godot Editor.

  2. Go to the Asset Library tab at the top of the editor.

  3. Search for "Modular Inventory" (by alvlp).

  4. Click Download, then Install. Ensure the install path is set to res://addons/.

Option 2: Via the Asset Library Website

  1. Go to the Godot Asset Library Website.

  2. Search for "Modular Inventory" (by alvlp) and download the .zip file.

  3. Extract the downloaded archive.

  4. Copy the modular-inventory-system folder directly into your project's res://addons/ directory.

Method B: Manual Download (Stable Release)

  1. Download the latest release archive from the Codeberg Tags page.

  2. Extract the downloaded archive.

  3. Copy the modular-inventory-system folder directly into your project's res://addons/ directory.

Method C: Git / Submodules (For Developers)

If you want the latest development version or plan to contribute, use Git.

Using Git Submodules (Recommended for Git projects):

Open your terminal in your Godot project root and run: 

git submodule add https://codeberg.org/alvlp/modular-inventory.git addons/modular-inventory-system
git submodule update --init --recursive

Using Standard Git Clone: 

git clone https://codeberg.org/alvlp/modular-inventory.git addons/modular-inventory-system

⚙️ Step 2: Enable the Plugin & Reload

Once the files are in your project, you need to activate the plugin and refresh the editor:

  1. Open your project in Godot Engine (or restart the editor if it was already open so it can detect the new files).
  2. Go to Project > Project Settings in the top menu.
  3. Navigate to the Plugins tab on the left.
  4. Find Modular Inventory in the list and check the Enable box.
  5. Reload the Project: Go to Project > Reload Current Project (or press Ctrl+F5 / Cmd+F5). (Reloading ensures the Godot editor fully recognizes all the new custom classes, resources, and scripts introduced by the plugin).

[!TIP] Autoloads are handled automatically! When you enable the plugin, it will automatically register the required Autoloads (DragDropSystem, InputMode, UICoordinator, etc.). You do not need to add them manually.

📂 Verify Your Folder Structure

If the plugin doesn't show up in the Plugins tab, check your folder structure. It must look exactly like this:

res://
└── addons/
    └── modular-inventory-system/
        ├── plugin.cfg  <-- This file must be directly inside this folder!
        ├── core/
        ├── ui/
        └── ...
(If plugin.cfg is hidden inside an extra nested folder, Godot will not detect the plugin.)