README.adoc

++++ ++++

= mod.io Unreal Engine Component UI Plugin

image:https://img.shields.io/badge/license-MIT-brightgreen.svg[alt="License", link="https://github.com/modio/modio-sdk/blob/master/LICENSE"] image:https://img.shields.io/discord/389039439487434752.svg?label=Discord&logo=discord&color=7289DA&labelColor=2C2F33[alt="Discord", link="https://discord.mod.io"] image:https://img.shields.io/badge/docs-master-green.svg[alt="Master Docs", link="https://docs.mod.io/unreal/"] image:https://img.shields.io/badge/Unreal-5.2%2B-green[alt="Unreal Engine", link="https://www.unrealengine.com"]

Welcome to the mod.io Unreal Engine Component UI repository. The Component UI plugin provides UI components, a template Mod Browser, and editor tooling to allow UE developers to rapidly implement mod.io-aware mod browsing and other elements into their game's UI.
It can be added either directly into existing screens or in dedicated browser and discovery sections.

== Engine & Platform Compatibility

This plugin requires the core mod.io plugin to be installed alongside it. Support for both plugins is generally maintained to support the 3 most recent versions of Unreal Engine.

=== Engine compatibility

|=== |Engine Version | Last Release |UE5.2 | 2025.2 |UE5.3 | 2025.9 |UE5.4 | 2026.3 |UE5.5 | Current |UE5.6 | Current |UE5.7 | Current |===

== Features

• UI-focused subsystem easing communication between UI elements and the core plugin
• Default UI component implementations that utilize the subsystem and visualize common mod.io data structures
• Interfaces and specifications to allow you to implement your own compliant components
• Template/reference implementation of a mod browser suitable for use as the basis of your own UI
• Permissive MIT/BSL-license

== Documentation Comprehensive documentation for this plugin https://docs.mod.io/unreal/component-ui[can be found here].

== Installation

=== Prerequisites

. This plugin relies on the mod.io core plugin, available at https://github.com/modio/modio-ue. Please ensure you have downloaded, installed and configured the core plugin prior to installing the Component UI plugin.

. To use this initial release of the Component UI plugin, you will need to remove our Legacy UE5 UI from the core plugin. Please delete the following folders from the core plugin's directories before proceeding:

* Modio/Source/ModioUI
* Modio/Source/ModioUICore
* Modio/Source/ModioUIEditor
* Modio/Content/UI5

. Please remove the ModioUI, ModioUICore and ModioUIEditor module elements from Modio/Modio.uplugin file

NOTE: The Legacy UE5 UI will be migrated to its own dedicated repository in the future - after that point, this manual cleanup will no longer be required.

=== Adding plugin files to your project ==== As a git submodule

. Add this repository as a submodule to your repository in your project's Plugins/ModioComponentUI directory + In the directory with your .uproject file: git submodule add https://github.com/modio/modio-ue-component-ui Plugins/ModioComponentUI . Initialize our submodules with git submodule update --init --recursive

==== In a non-git project, or without submodules

. Grab the latest release zip from the Releases section on this page, and extract the contents to your project's Plugins/ModioComponentUI directory

image:Doc/doc_root/en-us/component-ui/img/get_latest_release.png[] image:Doc/doc_root/en-us/component-ui/img/get_latest_release2.png[]

NOTE: The automatically generated zips on the release page and the 'Code' dropdown on this page will not work if this repository adds submodule dependencies in future releases. Please use the attached archive on the release instead.

== Game studios and Publishers [[contact-us]]

If you need assistance with 1st party approvals, or require a private, white-label UGC solution. mailto:developers@mod.io[Contact us] to discuss.

== Contributions Welcome

Our Unreal Engine plugins are public and open source. Game developers are welcome to utilize them directly, to add support for mods in their games, or fork them for their games customized use. Want to make changes to our plugins? Submit a pull request with your recommended changes to be reviewed.

== Other Repositories

Our aim with https://mod.io[mod.io], is to provide an https://docs.mod.io[open modding API]. You are welcome to https://github.com/modio[view, fork and contribute to our other codebases] in use.