Getting Started

This guide assumes you have already registered an account on PlayUR, and that the account has permission to add games. If you cannot see the Manage Experiments link, you will need to contact us to request access.

Create a PlayUR Game

  1. Visit the Manage Experiments page and click on Add Game. image image
  2. Fill in the details and submit.
  3. Take note of the generated Game ID and Client Secret as you will need these when configuring the PlayUR Plugin in Unity. image
  4. Ensure at least one Experiment and Experiment Group is configured on PlayUR. See Creating a PlayUR Experiment for information. image

Installing the PlayUR Package

  1. In your Unity project, open the Package Manager. image_small
  2. Click on the + button and choose Add Package from Git URL. image_small
  3. Enter https://github.com/lfwells/playur-unity-plugin.git image

Configure the PlayUR Plugin

  1. In Unity, choose PlayUR -> Plugin Configuration.... image
  2. In the PlayUR Settings, enter the Game ID and Client Secret from the previous steps. image
  3. For the other Setup Checks items, click Fix. image

Working With Source Control

  • The file Assets/PlayURPlugin/Resources/PlayURClientSecret.asset should not be committed to source control as it contains the client secret used to talk to the PlayUR servers.
  • The Element, Parameter, Experiment, ExperimentGroup, Action, and AnalyticsColumn enums are that you will generate via the PlayUR -> Generate Enums option should be committed to source control.

Next Steps

The plugin should now be ready to use! If you have already configured Experiments, Elements, and Parameters, these will already appear in Unity in the Debug Configuration section of the PlayUR Settings. From here, you should either:

  • For a practical example see how to Create A Simple Example which reads in a single parameter in Unity, or
  • Understand more about how PlayUR works via the Create a PlayUR Experiment and PlayUR User Lifecycle pages.

More Resources

The following resources should also be useful:

  • Unity Plugin, particularly how to extend the PlayURBehaviour class.
  • Samples
In This Article
Back to top Generated by DocFX