Installation#

Requirements#

Unreal Engine

5.6, 5.7 or 5.8

Platforms

Windows (Win64), Linux, macOS

Project type

Blueprint-only or C++

Dependencies

GameplayTagsEditor (enabled automatically)

ZagalaSpec is a development tool. Its modules are DeveloperTool and Editor modules, so nothing from ZagalaSpec ends up in a Shipping build.

Install from Fab#

  1. Open the Epic Games Launcher, go to Unreal Engine > Library and find ZagalaSpec under Fab Library.

  2. Click Install to Engine and pick the engine version your project uses. Repeat for every engine version you work with.

  3. Open your project. Go to Edit > Plugins, search for ZagalaSpec and tick Enabled.

  4. Restart the editor when prompted.

Edit > Plugins with ZagalaSpec enabled

Verify the install#

  1. Open Tools > Session Frontend and select the Automation tab.

  2. Type Features.ZagalaSpec in the search box. You should see groups such as Features.ZagalaSpec.Features.BlueprintFeature and Features.ZagalaSpec.Import.Features.Counter.

  3. Tick all of them and press Start Tests. all tests (scenarios) turn green. Some will have warnings but those are expected warnings from SUT when testing the features.

Session Frontend showing ZagalaSpec features

If the list is empty, see Troubleshooting below. Then continue with 1. Run your first feature.

Updating#

New versions are announced on Discord. There is no automatic update other than manually through the Epic Games Launcher.

  1. In the Epic Games Launcher, open Fab Library, find ZagalaSpec and click Update for each engine version you use.

  2. Read the Changelog for the new version before opening your project.

  3. Open the project and restart the editor if asked.

  4. Run the bundled examples again (see Verify the install) to confirm the update works, then run your own features.

Warning

Keep your feature registry out of the plugin folder.

ZagalaSpec stores the list of known scenarios and step patterns in a settings file. By default (Save Config To Plugin Folder enabled) that file lives inside the plugin’s Config folder, which the Launcher replaces on every update. Before you create your first feature, open Project Settings, search for ZagalaSpec, and untick Save Config To Plugin Folder in the ZagalaSpec feature settings. The registry is then saved with your project.

If you already updated and your features disappeared from the Session Frontend, nothing is lost: open each Feature asset and save it. Saving re-registers its scenarios and step entries.

Optional: slimming the plugin#

Remove tests and examples

The plugin ships with automation tests and example content. They take little space and never ship, but you can remove them from your engine installation:

  1. Delete the folders Source/ZagalaSpecTests, Source/ZagalaSpecEditorTests and Source/ZagalaSpecImportExportTests under the installed plugin.

  2. Remove the matching entries from the Modules array in ZagalaSpec.uplugin.

Warning

ZagalaSpecExamples is more than examples. If you remove ZagalaSpecExamples and ZagalaSpecExamplesTests, also delete the plugin’s Content/Blueprints, Content/Data and Content/Maps folders and the Source/ZagalaSpecExamples/Features sample files. Keep ZagalaSpecToolkit: it contains the UZagalaSpecChainLinkOnStep and UZagalaSpecChainLinkOnChainLink base classes that BlueprintFeature and the shared world-setup steps use, and removing it breaks BlueprintFeature. Only remove the examples once you have your own step classes in place.

The next Launcher update restores everything you removed.

Troubleshooting#

ZagalaSpec is not listed in Edit > Plugins

Confirm it was installed to the engine version the project uses (Launcher > Fab Library). Installing for one engine version does not install it for the others.

Edit > Plugins lists ZagalaSpec but no Features.ZagalaSpec tests appear

Scenarios are registered when a Feature asset is saved. Open a bundled Feature (for example Plugins/ZagalaSpec Content/DEMO/Data/BlueprintFeature/DA_BlueprintFeature) and save it. If the Session Frontend is already open, press its Refresh Tests button.

Tests appear but are red right after installing

Open Window > Output Log, filter by LogZagalaSpec, and read the failure reason. For world-based examples (Hoverboard, Checkpoint, Networking), close any Play In Editor session you started yourself before running them.

Anything else

Report it on the Discord Issues page or email support@zagalagamesolutions.com with the engine version and the Output Log lines tagged LogZagalaSpec.