Getting Started

Create a PlayUR Game

  1. Visit the Manage Experiments page and click on Add Game.
  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.
  4. Ensure at least one Experiment and Experiment Group is configured on PlayUR. See Creating a PlayUR Experiment for information.

Installing the PlayUR Package

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

Configure the PlayUR Plugin

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

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 generated based upon your game ID. Due to a limitation of generated files from Unity packages, these files are modified in the Library/PackageCache/io.playur.unity@#### folder. You do not need to commit these files to source control, however all collaborators will need to generate these enums themselves upon first opening the project via the PlayUR -> Generate Enums option.

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, the following resources should be useful: