Compiling and Activating the Plugin

• Extract the contents of the plugin zip to your project's Plugins directory.
• Close Visual Studio, then run the GenerateProjectFiles.bat command.
• Reopen UE5.sln in Visual Studio.
• Next, EITHER:
  • In your [ProjectName].uproject file in Visual Studio, add the following item to the end of your "Plugins" array to add and enable Consequence:

{
   "Name": "Consequence",
   "Enabled": true
}

• OR:
  • Run Unreal and then, from inside the editor, open Edit -> Plugins and search for Consequence, then check the box to enable the plugin. Now close and restart the Editor.
• Build your Startup Project in Visual Studio.
• Run the editor.

Add your Consequence Database

• In the Editor, select a directory inside your game's Content directory and right-click to add a new Data Asset. Select Consequence Database as the asset type and name your database. Save the file.

Run the Consequence Client and Submit your Project to Perforce

• Now that your Uplugin is running and you have a database, follow the Consequence Client Administration instructions to install and run the Consequence Client.
• Once the Client is running and connected to your Consequence project, click Submit to Source Control from inside Consequence.
• Confirm that the ConsequenceExport.json file has been submitted to your Perforce in the directory you configured for Consequence Client.

Configure Editor Settings

• Next, in the editor, go to your Consequence Editor Settings and Consequence Runtime Settings and configure them to point to your Consequence Database, the directory where you want your Consequence String Table (and other String Tables) to reside, and the directory where your exported ConsequenceExport.json file has been saved. Please read the information at Engine Settings when configuring these.

Import Consequence

• With your JSON file submitted and on disk, your settings configured, and the plugin enabled, you can now click the Consequence icon in Unreal's menu above the viewport.
• In the dialogue that pops up, click Update Without Submitting.
• Assuming everything has been successfully configured, you will see a success pop-up. If there are problems, please consult the log to determine the appropriate fix.
• Now if you go to Perforce and refresh, you will see the relevant files ready for submission. Provided you are happy with the submission, submit to Perforce.

Your Consequence installation is complete and ready for general use!