Simple Mod Support Framework
A downloadable asset pack for Windows, macOS, Linux, and Android
🧩 Simple Mod Support Framework
Simple Mod Support Framework is a lightweight and flexible modding solution for Unity projects. It allows developers to add basic mod support without building a complex scripting system from scratch.
The framework can load external JSON mod files and register custom items at runtime. Mod creators can define item names, descriptions, categories, prices, stack sizes, icons, and additional custom properties directly through JSON files.
Add JSON-based mod loading, custom item registration, safe validation, runtime icon loading, mod manifests, dependencies, loading priority, and a Mod Manager UI to your Unity project.
✨ Key Features
-
External JSON Loading
Load mod data from external JSON files at runtime. -
Automatic Mods Folder Creation
Automatically creates a Mods folder for external mod content. -
Runtime Item Registration
Register custom items while the game is running. -
Runtime Icon Loading
Load PNG and JPG item icons from mod folders. -
Custom Item Properties
Add game-specific custom properties through JSON data. -
Mod Manifest Support
Include mod ID, name, author, version, and description information. -
Dependencies & Loading Priority
Define mod dependencies and control loading order. -
Safe Sandbox Validation
Validate paths, file types, file sizes, JSON data, and duplicate IDs. -
Runtime Mod Reloading
Reload mod content during runtime for testing and iteration. -
Mod Manager UI
View loaded mods, loading status, warnings, and errors.
📄 JSON-Based Mod Loading
Mods are defined using external JSON files, making the system easy to understand, edit, and extend.
Mod creators can create item data without writing C# scripts.
JSON Item Data Can Include
- Item ID
- Item name
- Description
- Category
- Price
- Weight
- Stack size
- Icon path
- Custom properties
🎒 Custom Item Registration
The framework can register custom items at runtime and expose them through a clean C# API.
Developers can connect registered items to their own inventory, shop, crafting, loot, database, or gameplay systems.
Useful For
- Inventory systems
- Shop systems
- Crafting systems
- Loot tables
- Item databases
- Survival resources
- RPG equipment
- Sandbox objects
📦 Mod Manifests
Mods can include manifest information to describe who made the mod, what version it is, and what it contains.
Manifest Fields
- Mod ID
- Mod name
- Author
- Version
- Description
- Dependencies
- Loading priority
🔗 Dependencies & Loading Priority
The framework supports mod dependencies and configurable loading priority.
This helps developers control the order in which mods are loaded and detect missing required content.
Dependency Features
- Mod dependency support
- Missing dependency warnings
- Configurable loading priority
- Load order control
- Useful for larger mod collections
🛡️ Safe Sandbox Validation
The included safe sandbox system helps prevent invalid or unsafe mod content from being loaded.
Validation Includes
- Safe path validation
- Path traversal protection
- Allowed file type restrictions
- Configurable file size limits
- JSON structure validation
- JSON data validation
- Duplicate ID detection
- Namespace support
- Maximum mods limit
- Maximum items per mod limit
Invalid items can be skipped without stopping other valid mods from loading.
⚠️ Detailed Error Reporting
The framework provides warnings and detailed error messages to help developers and mod creators understand what went wrong.
Error Reporting Features
- JSON validation errors
- Invalid file warnings
- Duplicate ID warnings
- Missing dependency reports
- Skipped item reports
- Mod loading status information
🔄 Runtime Mod Reloading
Mods can be reloaded during runtime, making the system useful for testing, debugging, and rapid iteration.
Reload Features
- Reload external mod files
- Refresh registered item data
- Useful for development testing
- Works with the Mod Manager UI
🧰 Mod Manager UI
A Mod Manager UI is included to show mod loading status, loaded mods, warnings, and errors.
UI Features
- Loaded mod list
- Mod loading status
- Error viewer
- Warning viewer
- Runtime reload support
- Useful for debugging and player-facing mod menus
🧪 Editor Tools
The package includes editor tools to help create, validate, and debug mod content.
Included Editor Tools
- JSON Validator Editor tool
- Mod Template Creator Editor tool
- Mod Debugger window
💻 Developer C# API
Developers can access loaded mods and registered items through a clean, customizable C# API.
API Features
- Access loaded mods
- Access registered items
- Connect items to custom systems
- React to mod loading events
- React to mod loading failures
- React to item registration events
🎮 Suitable For
-
🧙 RPG Games
Add modded items, categories, icons, prices, and custom item data. -
🌲 Survival Games
Let mods add resources, tools, crafting items, loot, and survival objects. -
🚜 Simulators
Add configurable external content without changing the core project. -
🧱 Sandbox Games
Support modded items and custom data for player-driven content. -
🏪 Management Games
Load custom shop items, prices, categories, and balance data from JSON. -
🧰 Custom Tools
Use the framework as a base for project-specific mod loading workflows.
📦 Included
- External JSON mod loading system
- Automatic Mods folder creation
- Runtime custom item registration
- Runtime PNG icon loading
- Runtime JPG icon loading
- Custom item properties
- Mod manifest support
- Dependency support
- Loading priority support
- Duplicate ID detection
- Namespace support
- JSON validation
- Safe path validation
- Allowed file type restrictions
- Configurable file size limits
- Runtime mod reload support
- Mod Manager UI
- Mod loading status viewer
- Error viewer
- JSON Validator Editor tool
- Mod Template Creator Editor tool
- Mod Debugger window
- Developer C# API
- Demo scene
- Example mod files
- Fully customizable C# source code
⚙️ Technical Details
Mod Loading
- External JSON mod loading
- Automatic Mods folder creation
- Runtime mod reload support
- Mod manifest support
- Mod dependency support
- Configurable mod loading priority
Custom Items
- Runtime item registration
- Custom item names
- Descriptions
- Categories
- Prices
- Weight
- Stack size
- Custom properties
- Runtime PNG and JPG icons
Validation & Safety
- JSON structure validation
- JSON data validation
- Safe path validation
- Path traversal protection
- Allowed file type restrictions
- Configurable file size limits
- Configurable maximum mods
- Configurable maximum items per mod
- Duplicate ID detection
- Namespace support
- Invalid items can be skipped
Tools & UI
- Mod Manager UI
- Mod loading status viewer
- Error viewer
- JSON Validator Editor tool
- Mod Template Creator Editor tool
- Mod Debugger window
Developer API
- Access loaded mods
- Access registered items
- Events for mod loading
- Events for loading failures
- Events for item registration
Compatibility
- Windows standalone builds
- macOS standalone builds
- Linux standalone builds
- No external dependencies required
🧩 Add Simple Mod Support to Your Game
Load external JSON mods, register custom items, load runtime icons, validate files safely, manage dependencies, reload mods, and connect modded data to your own gameplay systems.
Simple Mod Support Framework provides a clean and extendable foundation for adding basic modding support to Unity projects without building a complex scripting system.
Purchase
In order to download this asset pack you must purchase it at or above the minimum price of $18.29 USD. You will get access to the following files:
Leave a comment
Log in with itch.io to leave a comment.