Mindworks Plugin Guide
Last updated
Last updated
Enter the Screen Recording Project page of Playturbo
Click the [Download the Mindworks Plug-in] button
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
2οΌOpen Package Manager UI by navigating to Window > Package Manager in main Unity menu
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
@Designer needs to create the project and fill out the parameter demand first.
1οΌOpen the Playturbo login page: 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
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.
@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.
*Search InfoοΌEnter Project ID or Project name can search for the project you are looking for.
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)
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.
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:
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:
6οΌPaste to embed the parameter code into your Unity project, after completing the parameter setting, click [Active] to activate the parameter.
*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.
@Engineer
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:
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).
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:
@Designer
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.
1οΌPick the app project you want to start recording by clicking [+] to create version;