ModularInventoryPlus Documentation¶
Welcome to the documentation for ModularInventoryPlus (MIP) — a production-ready UE5 plugin providing a complete, server-authoritative MMO/RPG framework.
Overview¶
- Introduction — What MIP is, key systems, backend stack, and what's included.
- Feature Showcase — Visual walkthrough of every major system.
- Requirements — Skill level, software, and hardware needed.
- FAQ — Common questions answered before you purchase.
- Changelog — Version history and updates.
Architecture¶
- Architecture Overview — Servers, sessions, orchestration primitives.
- Technology Stacks — UE and backend tech stack breakdown.
- Auth & Join Flow — Authentication, character selection, and server join flow.
Getting Started¶
- Prerequisites — Chocolatey, Node.js, UE source build, Linux cross-compilation, Docker.
- Installing Minikube & Agones — Local Kubernetes cluster with Agones for game server orchestration.
- Running the Backend — Clone the backend, start infrastructure, and run locally.
Framework¶
- Core Framework — GameMode, GameState, PlayerController, PlayerState, PlayerCharacter and common interfaces.
Components¶
- Component Index — All 87 component docs organized by domain (inventory, player, health, equipment, quest, etc.).
Actors¶
- NPC — Base interactable, NPC, NPC with storage, NPC interactable component.
- Mobs & Spawners — Mob, spawners (area/wave/trigger/respawn), triggers, AI.
- Pickups & Loot — Item pickup, lootables, loot box, gatherable, quest overlapper.
- Other Actors — Gate, player start, spawn helpers, damage applier, projectiles.
Systems¶
- Ability System — ASC, attribute sets, gameplay abilities, exec calcs.
- Equipment GE — Equipment gameplay effect and attribute application.
- Exchange — Exchange managers, requirements, data assets.
- Vendor — Vendor NPC, manager, purchase UI.
- Vendor Repurchasing — Repurchase storage and purpose tags.
- Action Limits — Time-windowed usage caps.
Inventory & Items¶
- Item Pieces & Instance — Item instance, item pieces (definition vs dynamic), save/replication.
- Item Piece Overview — UMIPItemPiece hierarchy and piece types.
Data Assets¶
- Data Assets Index — Index of all data assets (item, class, NPC, mob, quest, exchange/vendor, ability, equipment, etc.).
- Equipment Piece Asset — Equipment stats, GE class, mesh, crafting ops.
Interfaces, Subsystems & Widgets¶
- Interfaces Index — All UINTERFACE / I* interfaces.
- Definitions Reader — Definitions reader subsystem.
- Settings & BPFL — UMIPSettings, UMIPAPIUrlSubsystem, UMIPBPFL.
- Widgets Index — Index of 60+ widget classes.