Welcome to the mod.io Unreal Engine 5 Sample Project repository. This repository provides a simple example integration of the mod.io Unreal Engine plugin for projects built with Unreal Engine 5.0 or later. The sample project is Blueprint-only and demonstrates the core functionality of the mod.io plugin.
Its recommended that you do a full git checkout, as the latest version of the mod.io plugin is included as a submodule.
Once you check out the repository, you can simply launch the project in your choice of engine version (5.0 or later is supported) and Play In Editor to see the sample in action.
The sample project is a memory game where the player must reveal the same cards. The game was implemented using modern techniques, including the following plugins:
-
CommonUI: for interacting with the user interface.
-
ModularGameplay & GameFeatures: for better modularity, in particular, the ModdingFeature, BlackCardFeature, and HintFeature features are implemented with them.
-
ModdingFeature: to load mods and interact with them, encapsulating the mod.io plugin.
-
BlackCardFeature: to implement the black card feature. This feature should be activated by a mod.
-
HintFeature: to implement the hint feature. This feature should be activated by a mod.
-
-
EnhancedInput: to interact with gameplay.
-
JsonBlueprintUtilities: for parsing JSON mod data.
The game works well on both console and PC.
In this game, modding is done by providing a mod_data.json file that adheres to the following JSON schema:
{
"BackgroundTexturePath": "BackgroundImage.jpg",
"NumOfCardsPerMatch": 2,
"NumOfCards": 12,
"EnableBlackCardFeature": false,
"EnableHintFeature": false
}This file specifies the mod’s settings, such as the path to the background texture, the number of required cards to match, and whether to enable the black card and hint features. You can find examples of mods on the mod.io game page.
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.