# Mindworks Plugin Guide

## Part 1: Installation

### 1. Download Plugin

* Enter the Screen Recording Project page of Playturbo
* Click the \[Download the Mindworks Plug-in] button 

![](/files/weygF14cRa801EiaeExS)

### 2. Install the Plugin

Please follow step-by-step instructions when installing Mindworks Plugin into a new or existing Unity project.

1）Unity needs to install the WebGL Build Support module

![](/files/sn8m1FYekdrZlZurjwHl)

2）Open Package Manager UI by navigating to Window > Package Manager in main Unity menu

![](/files/9EHZpulQENhUC1QUjfmt)

3）In Package Manager UI, hit "+" button located in lower left part of the window, choose "Add package from disk" and select \<package.json> from scripts folder you unzipped

<figure><img src="/files/pqrpIskvY0QkGrogyKyO" alt=""><figcaption></figcaption></figure>

## Part 2：Parameters Configuration

### 1. *<mark style="color:red;">@Designer</mark>* Create the project&#x20;

* @Designer needs to create the project and fill out the parameter demand first.

1）Open the Playturbo login page: [*https://playturbo.mindworks-creative.com*](https://playturbo.mindworks-creative.com/) in your browser (Google Chrome recommended for better experience). And log in to your own subscription account, click to enter the \[Screen Recording Project] tool

<div align="left"><img src="/files/K0toqIcqBOFs1Luyi09k" alt="" width="200"></div>

2）You can see the \[Create New Project] button in the upper right corner. Enter "Basic Information" and "Screen Recording Parameters" to complete the creation.&#x20;

<figure><img src="/files/ccpbuC2J8hyPXMJJrJ0D" alt=""><figcaption></figcaption></figure>

### 2. <mark style="color:red;">@Engineer</mark>  Configure the parameters&#x20;

* @Engineer needs to configure the parameters wrote by @Designer in Unity software.

1）If this is the first time you open the Mindworks plugin, you will need to Log in to your Playturbo account.

Click on Mindworks > Bulid on the upper bar and input Playturbo Username and Password to log.

<div align="left"><img src="/files/c27RxSoFd58Mru16Cj5p" alt="" width="357"></div>

\*Search Info：Enter Project ID or Project name can search for the project you are looking for.

<div align="left"><img src="/files/CYyvaqCU3PpKzLu6DmMA" alt=""></div>

2）After completing the previous step, the corresponding project will display in the \<Project List> of the plug-in, click \[select] to enter the Build interface, you can see the project information (Project Info), product information (App Info), and your preset Parameter information (Params)

<div align="left"><img src="/files/TYp5ePHmBTr2YzlRz2Yh" alt=""></div>

<div align="left"><figure><img src="/files/yD6Mb4FYyPuQNHo1wckx" alt="" width="563"><figcaption></figcaption></figure></div>

3）Customized Parameter

The types of parameters include Radio Button, Checkbox, Radio Drop-Down,Multi-Select Drop-Down and Value. You can select the \[Copy Code] button corresponding to the parameter on the Build interface to obtain and add the codes in the game. Game content will display differently according to the selected parameter.

such as: MWRuntime.getCfgValue\<double>("Character Attack Power")

4）Bulid interface includes the following info:

① \[name]：Name of the parameter

② \[desc]：Description of the parameter

③ \[value]：Value of the parameter

④ \[active] checkbox：After paste and embed the parameter code into your Unity project, click \[Active] to activate the parameter, in the meanwhile the parameter will be updated to Playturbo \<screen recording project> page online.

⑤ \[reload] check box：If this box is checked, the gameplay will reload from the beginning after you adjust the parameter every time.

<div align="left"><figure><img src="/files/7mb1VhJOHLFzbkZg8bCx" alt=""><figcaption></figcaption></figure></div>

5）Reload

5-1）If you check the reload box, then the gameplay will reload every time whenever you edit the parameter.

a. It is default to reload start from scene1

b. If you don’t want to reload from scene1, you can use\<MWRuntime.GameRetryEvent += this.onGameRetry> to monito, and use\<onGameRetry>to set the which scene to start and reload, refer to the example below:

<div align="left"><img src="/files/zl2vTX4Nw2W3ILKriYSw" alt=""></div>

5-2）If you prefer not to reload the gameplay every time you edit the parameter code, and you still want the parameter can update in real time, please refer to the following solutions:

(For example, when preparing to record a video, there is already a part of the game progress. At this time, if you need to change the skin of character A to character B, but you don’t want the current game to refresh and reset the game progress, you can do this set up.)

a. Receive parameter changes immediately with the \<update> session

b. Or you can receive feedback by adding \<onGameConfigChanged> to \<MWRuntime.UpdateGameConfigEvent += this.onGameConfigChanged>, you will receive feedback whenever there is a change of the parameter, refer to the example below:

<div align="left"><img src="/files/u09BcOCmfWDlkRSW6JgI" alt=""></div>

6）Paste to embed the parameter code into your Unity project, after completing the parameter setting, click \[Active] to activate the parameter.

<div align="left"><figure><img src="/files/yAnSRtEWysFC6FeBfsvi" alt="" width="563"><figcaption></figcaption></figure></div>

\*Third Party SDK

Any SDKs or toolkits that involve advertising, or sending and receiving any kind of analytics data to external servers must be avoided as errors may occur.

## Part 3: Build & Upload

<mark style="color:red;">@Engineer</mark>

There is a \[Build & Upload] button at the bottom of Unity's Build interface, and you need to wait patiently for a few minutes after clicking on it:

<div align="left"><figure><img src="/files/7OgxEL7oSPmOdjmK4sbe" alt="" width="563"><figcaption></figcaption></figure></div>

1）If the build is successful, the result will be printed on the Unity console, and at the same time, it will try to upload the result to the Playturbo platform. If the upload is successful, you can see the project status as \[Uploaded] on the Playturbo platform(refer to the screenshot).

<div align="left"><figure><img src="/files/nBxSpKzsbOgUeET3DAbt" alt=""><figcaption></figcaption></figure></div>

2）If the build fails, errors will be displayed in the Unity console, please resolve them before attempting to build again;

Note: If you need to rebuild the uploaded project, you need to change the lock status of the project, refer to the screenshot below:

<div align="left"><img src="/files/AMq6VQsRXcMk3d9vN9YP" alt=""></div>

## Part 4: Start the Recordings

<mark style="color:red;">@Designer</mark>

1）Pick the app project you want to start recording by clicking \[+] to create version; ![](/files/j8grLCXvet1ErQFLEm6P)

2）After redirect to the recording page, you can click \[Start Recording] to record the video you want. After the recording is completed, click \[Complete Recording] to finish recording, and to save and export your work.

<div align="left"><figure><img src="/files/4iVgPTxp9l8lTArtVoOF" alt=""><figcaption></figcaption></figure></div>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.playturbo.com/screen-recording-tool-screen-recorder/1.-preparations/mindworks-plugin-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.