Skip to content
Automation for Unity games
Branch: master
Clone or download
Latest commit ce45449 Jul 15, 2019

README.md

Unium

A library for game automation.

Unium is a library for game automation.

It exposes an external API intended for external tools and automated testing.

There are two parts:

  • A web server that is embedded into the game
  • A query language that lets you search and manipulate the scene graph

This provides a flexible interface so you can remotely control and inspect your game as it runs.

Philosophy

It should just work

You should not have to modify you game in any way in order to automate it.

It should work for game developers

It should fit with game developer ways of working.

The intended audience is game developers first and technical testers second. It should not compromise their experience with other considerations.

It should not lock you into a specific language or framework

You should be able to write your automation and test scripts in any language or framework you choose. Unium should come with no dependencies or stipulations.

It should be open source

Both in spirit and practice.

Getting Started

Tutorial

For a live tutorial that will guide you through unium and it's features

Your default browser should open automatically. The tutorial is best experienced with the editor and browser side-by-side.

Documentation can be found in the corresponding unium.pdf file.

Installing Unium to your Project

To install unium to your project.

  • Copy the Unium library (the Assets/Unium directory) to your project
  • Add the UniumComponent to an empty game object in your scene
  • Enjoy

NB: Remember to enable the development build flag if you are making builds (unium is disabled for release by default).

Notes

Writing Tests

The Unium API facilitates automated tests but is not a testing framework. Below are a number of popular frameworks that have been used with Unium.

Compatibility

  • Compatible with Unity 2017.4.30 and up
  • The aim to is to keep it compatible with the lowest LTS version officially supported by Unity

Tutorial Video

Unium Tutorial Video

Demonstration of Unium and Appium working together

Unium with Appium

You can’t perform that action at this time.