The first 3 steps in this process are a little involved. So this should be done by a developer. Or if you host your own server you should be able to do this.

Setup Server

Note: If you don't have a server or don't want to set one up, you can use www.playtesttookit.dutchskull.com. Dont use for actual projects, only for tying out play test toolkit.

Setup Unity

Setting up play test

Video tutorial

• Git
• Docker
• Docker-compose
• As server with a minimum of 1.5 GB of RAM (You can use a hosting website like Google Cloud)

Make sure you have Git installed. Connect to your server through ssh or any other means. Now use the command given down here to clone the repository.

git clone https://github.com/WhiteOlivierus/PlayTestToolkitPackage.git

When the repository has been cloned you can navigate to the folder with the Docker compose.

cd PlayTestToolkit/PlayTestToolkitWeb

Make sure that you have Docker and Docker-Compose installed. Now you can run the Docker-Compose command with -d for detached.

sudo docker-compose up -d

Note: it won't give 5 times a green done you should run this command without -d to report a bug.

If you haven't all ready, you should open the port 80 in your firewall and on your route so you can access this server. This is dependent on what server and router you have, so you can check this with your web provider and server provider.

Now we can check if the setup was success full. By default the Nginx server that servers up the API and web interface is configured to pass all traffic through localhost. So if you go too your browser and enter the server IP, you should see the play test toolkit web interface.

If you have a domain that you want to use for this, you can configure the nginx.config for yourself. The config file is located here relative to the git repository root.

cd PlayTestToolkit/PlayTestTookitWeb/Nginx/nginx.config

You can use the video tutorial in combination with the written explanation if you are not able to figure things out.

Video tutorial

First we have to add the registry for play test toolkit to your Unity project. This step can be done in various ways depending on your Unity version. So choose the Unity version you are using.

Go to Edit > Project Settings. In the Project Settings window, find the tab Package Manager. Here you will have a place you can add scoped registries.

Note: In some of the unity 2019 versions you don't have the project settings for package manager yet, so for those use the 2018 way.

Here you can add a scope registry. You can do this by pressing the plus in the right column. Fill the new scoped registry like illustrated in the image down bellow. Don't forget to press apply after filling in these fields.

Go to your unity project folder and find the folder called Packages. In this folder you will find a file called manifest.json. When you open this file you will see a list of dependencies.

Here you will add after the starting { this code snippet.

If you don't have any scoped registries you can add the code below.

}
    "scopedRegistries": [
        {
            "name": "Play Test Toolkit",
            "url": "http://unitypackages.dutchskull.com/",
            "scopes": [
                "com.dutchskull"
            ]
        }
    ],

Otherwise add the part below between the comments

}
    "scopedRegistries": [
        // Add the text bellow between the square brackets of the scoped registry
        {
            "name": "Play Test Toolkit",
            "url": "http://unitypackages.dutchskull.com/",
            "scopes": [
                "com.dutchskull"
            ]
        },
        // Until here white out these comments

Or add this entry too the existing scoped registries if you have more of them.

Now save this file and let's got Unity.

In Unity we will have to install the Play Test Toolkit package. This can be done by going to Window/Package Manager. When the package manager is opened you can look in the left corner of the window to find a drop down with the text Unity Registry. In this list that appears when you click on it, there should be a entry that says My Registries and you can select that.

Note: If you don't see My Registries you need to go back to step one of Setup Unity.

Here you will find the Play Test Toolkit package, and like any other package you can select it and install the package. This package also depends on the samples to be imported. In the Package Manager under Play Test Toolkit there should be a text with samples, and under there a text that says Resources. Now import the resources by pressing the Import in to project button.

As a last step we need to connect the Play Test Toolkit to the server. This can be done by going to Edit/Project Settings. Here there will be a entry that says Play Test Toolkit. When you go to that tab it will show a empty field for a web url. This is where you will add the server IP or URL to the web side of Play Test Toolkit.

Note: If you didn't setup your own server you can use the current one in the image below. This means that everybody can access the play test's you are uploading there, so only use it to checkout the tool.

If you all ready have text mesh pro setup, you can skip this step.

Otherwise go to Window/TextMeshPro/Import TMP Essential Resources and import those.

Now we are all done to start setting up play tests.

Video tutorial

Note: Make sure your game closes gracefully, by calling OnApplicationQuit. Alt+F4 will not send data to the servers yet.

In the Play Test Toolkit window in unity you can press the Setup a play test button. Here you can fill in the information needed to make a play test. When you don't want to build directly after this, you can just press save and edit it later again. If you would like to make a build press the save and build button. This will build your play test and upload it to the server.

Note: for now this build will also be available in the project folder under \Builds.

In the Play Test Toolkit window in unity you can press the share button. This will copy a link too the shareable build.

Go to the web interface using your server IP or the URL. Then you can navigate too the play test which you want to look at it's data.

You can export the data you have collected to a .CSV and import that in your spreadsheet editor of choice. The format for this document is like this.