Skip to content

Overview and Setup

GUITools is a derivative tool outside of VketCloudSDK designed to edit and save the Activity Canvas GUI for VKC Item Activities in worlds created in Vket Cloud. The tools are primarily divided into GUI Importer and GUI Exporter, and the json files saved by the edits made in GUITools are referenced at the time of world loading. If a new UI is added, it needs to be defined by HeliScript. For more details, see Advanced Implementation and Built-in Functions - GUI.

A. Preparation

As preparation, set up the Unity project and install the VketCloudSDK according to the procedures in How to Install VketCloudSDK.

Points to Note When Setting Up the Environment

  • The editor version should be 2019.4.31f1
  • Use the 3D template
  • Ensure the project name does not include spaces, Hiragana, Katakana, Kanji, or any other double-byte characters

From here on, explanations will be provided with Unity's Layout in "2 by 3" and the Project view in One Column Layout.

B. Installing GUITools

GUITools_Setup_01

Select Edit > Project Settings… from the top tab in Unity.

GUITools_Setup_02

Choose Package Manager, click +, and enter the following information, then select Apply.

Item Input
Name VketCloudSDK_GUITools
URL https://registry.npmjs.com
Scope(s) com.hikky.vketcloudguitools

After applying, select Window > Package Manager from the Unity top tab.

GUITools_Setup_03

When you switch the display tab to My Registries, VketCloudSDK_GUITools should be displayed.

GUITools_Setup_04

Click the Install button to perform the installation.

If the installation does not complete

When installing GUITools v13.0.0, the installation may continue indefinitely.

In such cases, restarting the Unity project may resolve the issue.

C. Installing UniTask

If UniTask is not automatically imported depending on the environment, please install UniTask from the PackageManager.

GUITools_Setup_03

Click the + button in the upper left corner, and select Add package from git URL…

GUITools_Setup_06

Copy the following URL into the textbox that appears and click the Add button

*Skip this step if UniTask is already included in the project

https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask

GUITools_Setup_07

Once the installation is complete, VketCloudGUITools is now installed. Confirm that 'VketCloudGUITools' is displayed in the Unity top tab.

GUITools_Setup_05