Skip to main content
Version: v1.21

XR Center installation

Software Prerequisites​

Hardware Minimal Prerequisites​

  • SSD : 128 Go + blob storage if installed on the same machine
  • CPU : 4Core-2,8 GHz
  • RAM : 16 Go

If your Prep Agent is on the same machine, here are the recommendations:

  • CPU: 8Core-2,8 GHz
  • RAM: 64 Go

Installation​

XR Center is a server/client architecture, therefore it is preferable to install it on an appropiated infrastructure.
However, to benefit locally from all the possibilites offered by XR Center, it is possible to install all the packages on the same machine.

This procedure describes a standard installation on a single machine.
The procedure for complex infrastructures is quite similar, but spread across different machines.

1 - Execute Skyreal Suite Server Setup​

  • Choose installation path
  • Install core components only (no extension)

2 - Install database​

  • Execute Database installer from C:\ProgramData\Skydea\xrcenter\Dependencies\
  • Follow instructions and choose a not empty root password
  • Be sure to install it as a service (needs elevated privileges)

In case Arango is installed on a machine seperated from XR Center, you have to authorize external connexions.

  • Edit C:\Program Files\ArangoDB3 3.11.3\etc\arangodb3\arangod.conf
  • Replace endpoint = tcp://127.0.0.1:8529 by endpoint = tcp://0.0.0.0:8529
  • You can also customize the port by the way.

3 - Setup Server​

  • Execute XRCenterSuiteConfigurator from Windows Start Menu
  • Set XR Center paths
License​
  • Set Licenses directory path (default should be "C:\ProgramData\Skydea\xrcenter\licenses")
  • If fingerprint is not displayed, refresh the page clicking on Previous button, then Next button.
    Copy the fingerprint and request your license from the Skyreal support team.
  • Click on Import license and paste your license in the folder. (more details)
  • Generate a Client Secret to secure the connexion of the agents to your XR Center. Then copy it.
SSL Certificate​

XR Center contains a default self-signed SSL Certificate for the https connexion.
You can keep it for a local installation.
However it should be replaced in case of a server installation.

Database connexion​
  • Update root password
  • Test connexion
Service​
  • Install Service
  • Start Service

4 - Install Extensions to Marketplace​

Install one by one the Skyreal extensions you need from the Server package. (not from the main installer)

5 - Setup Agent​

  • Open Windows Services
  • Restart XR Center service
  • Execute XRCenterSuiteConfigurator from Windows Start Menu
  • Go directly to Prep Agent
  • Paste the XR Center Client Secret (you can copy it from the previous page of the Configurator)
  • Test Connexion
  • Install service
  • Before you start it, check the UnrealEditor-Cmd.exe path
  • Start the service

6 - Install Client​

Client Setup

Administration​

An administration web app is available at https://xrcenterip:port. It is dedicated to IT administrators. For more information see XR Center Administration page

Advanced configuration​

How to edit config file​

XR Center and Prep Agent configuration files can be manually edited from their respective location:

  • XR Center: C:\ProgramData\Skydea\xrcenter\xrcenter.json
  • Prep Agent: C:\ProgramData\Skydea\xrcenter-agent-prep\xrcenter-agent-prep.json

Those json files must respect json synthax. Please use an online json validator service if you are not sure.

The corresponding services must be restarted so that your modifications are taken into account.

Common mistakes​

  • brackets not closed
  • forgotten or extra comma
  • \ not escaped (for paths, you must duplicate backslashes like this \\)

XR Center Configurations​

  • Change logs directory: LogDirectoryPath: ""
  • Change Blob location:
"DataStore": {
	"DatabaseServerUrl": "http://localhost:8529/",
	"DatabaseServerUsername": "root",
	"DatabaseServerPassword": "root",
	"BlobStorageType": "Local",
	"BlobDirectoryPath": "" <-- HERE
},
  • Change Marketplace packages location:
"MarketplaceSettings": {
	"ScanDirectoryPath": "",
	"PackageArchivesDirectoryPath": "",
	"ScanNewPackages": true
}
  • Customize Preparation Options:
"SkyPrepAgentSettings": {
    "AllowParallelProcessing": true,
    "UnrealEngineUseNanite": false,
    "UnrealEngineNaniteMinTriangleThreshold": 2048
}
  • To customize the ports:
"Kestrel": {
	"Endpoints": {
		"Http": {
			"Url": "http://+:9227"
		},
		"Https": {
			"Url": "https://+:9228" <-- HERE
		}
	}
}
  • Add Plugins:
"OptionalPlugins": [
	<-- Add plugin names
]

Prep Agent Configurations​

  • Data location (conversion temporary files): "DataDirectoryPath": ""
  • Packages location (last Skyreal plugins and extensions): "PackagesDirectoryPath": ""
  • Editor Plugins location (last editor plugins): "SkyRealEditorPluginsDirectoryPath": ""
  • Unreal Editor Command Executable path: "UnrealEditorCommandExePath": "C:\\Program Files\\Epic Games\\UE_5.5\\Engine\\Binaries\\Win64\\UnrealEditor-Cmd.exe"