/modio-ue4

Unreal Engine Plugin for easily integrating mod.io into your game - the UGC management service for game developers

Primary LanguageC++OtherNOASSERTION

mod.io

mod.io Unreal Engine Plugin

License Discord Unreal

Welcome to the mod.io Unreal Engine Plugin public repository. It allows game developers to host and automatically install user-created mods in their games which use UE 4.26 or newer. It provides a C++ and Blueprint interface around the mod.io SDK, which connects to the mod.io REST API. We have a test environment available, and developers can create a game profile there to evaluate the plugin with.

Features

  • C++ and Blueprint support

  • Permissive MIT/BSL-license

  • Async delegate-based interface

  • Non-blocking IO

  • Automatic downloads and updates

  • Email / Steam / GoG authentication

  • Mod Browsing / Filtering

Installation

Adding plugin files to your project

As a git submodule

  1. Add this repository as a submodule to your repository in your project’s Plugins/Modio directory

    In the directory with your .uproject file: git submodule add https://github.com/modio/modio-ue4 Plugins/Modio

  2. Initialize our submodules with git submodule update --init --recursive

In a non-git project, or without submodules

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

get latest release get latest release2

Note
 The automatically generated zips in on the release page, or the 'Code' dropdown here, will not work! They do not contain our submodule dependencies.

Enabling the plugin

Start the editor, then enable the plugin in the Unreal Engine settings:

plugin window

Once this is done, you can configure the plugin and get started.

Plugin Configuration

The plugin requires some configuration information to behave correctly. You can access the configuration settings in the Project Settings window:

plugin settings

The settings have the following parameters:

Game Id

Your mod.io-provided Game Id for the target environment (Live, or Test)

API Key

Your mod.io-provided API key for the target environment (Live, or Test)

Environment

Are you targeting the production/live environment or the private/test environment?

Log Level

The default logging level to use. Messages with a lower log level will be silently discarded.

Portal

The default portal to use. This usually corresponds to the store your game will be being distributed through.

Further reading

To begin using the Plugin, either from Blueprint or from C++, please read our Getting Started Guide for a detailed explanation of initialization and usage.

Example Projects

We provide an example Blueprint implementation of the plugin in a simple demonstration project. You can find the example project here.

Large studios and Publishers

A private white label option is available to license, if you want a fully featured mod-platform that you can control and host in-house. Contact us to discuss.

Contributions Welcome

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

Other Repositories

Our aim with mod.io, is to provide an open modding API. You are welcome to view, fork and contribute to our other codebases in use.