Get started

Modl:test is an automatic game testing solution powered by the modl AI engine.

You can use the modl:test plugin to configure a bot to explore and interact with your game. If you have configured a bot and levels, go to the modl.ai platform to view and manage your test reports.

The table below details the different information modl:test can report on:

Information type	Description
Crashes	Events in which the game crashes.
Custom events	Customs events that you want modl to report on. For further information, refer to Report events.
Bot actions	Actions that the bot takes during a test run.
Bot position	Positions the bot has visited during a test run.
Game state	Variables that you want to track during a test run.

Prerequisites

To use modl:test, your project needs the following:

• Unreal 5.1.1+
• Enhanced input system

Note: You must build your project as a development build to upload it to the platform. You cannot upload a packaged build.

Set up a modl account

You can install and preview the modl:test plugin without an account but you need to set up a modl account to run tests on the modl.ai platform.

To request a copy of the modl:test plugin or sign up for an account, reach out to sales.nosp@m.@mod.nosp@m.l.ai.

Install the plugin

To set up an account and get a copy of the modl:test plugin, refer to Set up a modl account.

If you already have a local copy, use the following the steps to install the modl:test plugin into your project:

1. In your file explorer, go to the [Unreal Engine root folder]/Engine/Plugins.
2. Open the Marketplace folder. If you don’t have a Marketplace_ _folder, you can create one.
3. Copy the zipped ModlAI plugin folder into the Marketplace folder.
4. Unzip the ModlAI plugin folder.
5. Open your Unreal project.
6. Go to Edit > Plugins.
7. Search for and enable the Modl AI Plugin.
   
8. Save your settings.
   
9. Restart Unreal.