How to install VketCloudSDK
To install the VketCloudSDK, the Unity Package Manager and the VketCloudSDK install wizard is required.
Step 1. Open a project in Unity
Open a project of a supported version (Unity Pre-prep) or create a new project. Select "3D" as the template, if you need one.
Note
If you put a space in the project name, it may cause build failures and other issues.
We advise to avoid using full-width characters such as CJK characters.
OK) MyProject NG) My Project , マイ プロジェクト
Step 2. Register Registry information
Note
On the release of Version 9.3, the SDK installation registry has been changed to the install wizard.
If you want to install the install wizard on an existing project, you must create a new registry by selecting "+", and do not overwrite the existing SDK registry.
After installing the install wizard, proceed to Installing a specified version / Updating an existing SDK.
Open the "Project Settings" window from the Unity menu Edit > Project Settings.
Select "Package Manager" from the left tab in the window and describe as follows.
| item | value |
|---|---|
| Name | VketCloudSDK Install Wizard |
| URL | https://registry.npmjs.com |
| Scope(s) | com.hikky.vketcloudsdk-install-wizard |
Finally, press the "Save" button to save the settings.
Note
If the registry contains a space or any unneeded characters, the error below may appear.
If the error appears, please check if a space is contained by mistake.
Step 3. Install the VketCloudSDK Install Wizard via Package Manager
Open the "Packages" window from Unity's menu Window > Package Manager.
Select "My Registries" from the dropdown at the top of the window.
Select the VketCloudSDK Install Wizard from the displayed list and press the “Install” button to start the installation.
Installation is complete if the window and Unity menu is displayed as below:
Step 4. Install the SDK using the Install wizard
To install the SDK on a new project, use the SDK Install Wizard.
1. Select the SDK Installation Wizard on the Unity menu.
By opening the Install Wizard, the window will appear as below.
2. Select the "Next" button to select the preferred language. This language will be used throughout the Installation Wizard.
3. The window for setting the recommended initial settings will appear. Complete all three settings to proceed.
Although the recommended settings may be ignored, SDK functionality cannot be guaranteed in such case.
4. By finishing each setting, a check mark will appear on each article.
By ignoring the settings and selecting the "Next" button, a window of warning will appear.
5. By selecting "Next", the version selection window will appear.
The SDK version can be chosen from stable, latest, archive versions.
Note
The archive versions are deprecated and planned to be unaccessible in the near future.
Do not use these versions for setting up new world projects.
6. After selecting version and proceeding by selecting the "install" button, the package import will begin.
7. After waiting approx. 2~5 minutes, the installation will be completed with the window below.
The SDK manual and community discord server can be accessed from this window.
Installing a specified version / Updating an existing SDK
For a project with an existing SDK, the SDK Version Manager can be used for switching and updating SDK versions.
Version switch via SDK Version Manager
1. By selecting VketCloudSDK_Wizard > SDK Version Manager, the version selection window will appear.
2. Select the new version to be installed, and press the "Install" button.
Note
The archive versions are deprecated and planned to be unaccessible in the near future.
Do not use these versions for setting up new world projects.
3. By selecting the install button, the import window will appear as below.
4. As the installation is completed, the version completion window will appear as below.
The SDK manual and community discord server can be accessed from this window.
Note
On updating an existing SDK, Components may be gone missing after the update.
We strongly recommend to take a backup of the pre-update project by duplicating files.
Note
If issues such as build errors appear on updating the SDK, please refer to the page below:
Version Update Troubleshooting
Note
The version switching methods below remains to be usable, using the version manager is recommended.
Version switching via Package Manager
After registering the registry information on Step 2., open the Package Manager via "Window" --> "Package Manager".
In the Package Manager, make sure that the VketCloudSDK shows up on switching the registry view to "My Registries".
On selecting "See all versions", all released SDK versions will be listed.
Select the SDK version to be installed, then proceed by selecting the "Install" or "Update to [Version]" on the bottom right to install the SDK.
Version switching via manifest.json
Editing the manifest.json is also available for switching versions.
To open the project's manifest.json, right click on the Project window and select "Show in Explorer", which enables to locate the file in "Projects"-->[Project Name]-->"Packages".
By editing the version number on the right side of "com.hikky.vketcloudsdk", the installing / updating version will be switched.
Note
If VketCloudSDK fails to show on the Unity menu, it may appear by rebooting the editor.
One of the reasons may be the lack of essential SDK packages, as the Deeplink package may fail to be imported automatically.
If such cases occur, please try a manual package import.
As the EditorTutorialSystem may also rarely fail to be imported automatically, add the package below following the instructions on Step 2. on such occurence.
| item | value |
|---|---|
| Name | EditorTutorialSystem |
| URL | https://registry.npmjs.org |
| Scope(s) | com.hikky.editortutorialsystem |