net.wooga.uvm

Class UnityVersionManager

java.lang.Object

net.wooga.uvm.UnityVersionManager

public class UnityVersionManager
extends java.lang.Object

This is a simple native interface for the unity version manager tool. It loads the needed dynamic library from the resource directory at startup time.

Constructor Summary

Constructors

Constructor and Description
UnityVersionManager()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	detectProjectVersion(java.io.File projectPath) Detects the unity editor version used in projectPath.
static java.lang.String	detectProjectVersion(java.io.File projectPath, boolean withRevisionHash) Detects the unity editor version used in projectPath.
static Installation	installUnityEditor(java.lang.String version) Installs the given version of unity to default destination.
static Installation	installUnityEditor(java.lang.String version, Component[] components) Installs the given version of unity and additional components to default destination.
static Installation	installUnityEditor(java.lang.String version, java.io.File destination) Installs the given version of unity to destination.
static Installation	installUnityEditor(java.lang.String version, java.io.File destination, Component[] components) Installs the given version of unity and additional components to destination.
static Component[]	listAvailableComponents(java.lang.String version) List all available components for the given unity version in the current platform.
static Installation[]	listInstallations() Lists Unity installations.
static Installation	locateUnityInstallation(java.lang.String unityVersion) Returns the path to the installation location for the provided version or Null.
static java.lang.String	readUnityVersion(java.io.File installationLocation) Return the version as String of the unity installation at the provided location or Null.
static java.lang.String	uvmVersion() Returns the uvm core library version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnityVersionManager

public UnityVersionManager()

Method Detail

uvmVersion

public static java.lang.String uvmVersion()

Returns the uvm core library version.

Returns:

the uvm core library version

listInstallations

public static Installation[] listInstallations()

Lists Unity installations.

Returns:

an array of Installation or null

detectProjectVersion

public static java.lang.String detectProjectVersion(java.io.File projectPath)

Detects the unity editor version used in projectPath.

Parameters:

projectPath - the path to the unity project root

Returns:

a version string or NULL

detectProjectVersion

public static java.lang.String detectProjectVersion(java.io.File projectPath,
                                                    boolean withRevisionHash)

Detects the unity editor version used in projectPath.

The second Boolean parameter withRevision controls the format of the version string. When set to true the returned version will be based on the m_EditorVersionWithRevision parameter in the ProjectVersion.txt file. e.g. 2020.3.38f1 (8f5fde82e2dc)

Note: If the project is saved in an older format without the m_EditorVersionWithRevision parameter, then the m_EditorVersion parameter will be used which contains only the base version. Even if the m_EditorVersion is used the version could be returned with a release hash. But only if the version is known to uvm.

Parameters:

projectPath - the path to the unity project root

withRevisionHash - return the version with the release revision hash

Returns:

a version string or NULL

locateUnityInstallation

public static Installation locateUnityInstallation(java.lang.String unityVersion)

Returns the path to the installation location for the provided version or Null.

Parameters:

unityVersion - the version string to fetch the installation location for

Returns:

a Installation object or null

installUnityEditor

public static Installation installUnityEditor(java.lang.String version,
                                              java.io.File destination)

Installs the given version of unity to destination.

If the unity version is already installed, returns early.

Parameters:

version - the version of unity to install

destination - the location to install unity to

Returns:

a Installation object or null

installUnityEditor

public static Installation installUnityEditor(java.lang.String version)

Installs the given version of unity to default destination.

If the unity version is already installed, returns early.

Parameters:

version - the version of unity to install

Returns:

a Installation object or null

installUnityEditor

public static Installation installUnityEditor(java.lang.String version,
                                              Component[] components)

Installs the given version of unity and additional components to default destination.

If the unity version and all requested components are already installed, returns early.

Parameters:

version - the version of unity to install

components - a list of optional Components to install

Returns:

a Installation object or null

See Also:

Component, Installation

installUnityEditor

public static Installation installUnityEditor(java.lang.String version,
                                              java.io.File destination,
                                              Component[] components)

Installs the given version of unity and additional components to destination.

If the unity version and all requested components are already installed, returns early.

Parameters:

version - the version of unity to install

destination - the location to install unity to

components - a list of optional Components to install

Returns:

a Installation object or null

See Also:

Component, Installation

listAvailableComponents

public static Component[] listAvailableComponents(java.lang.String version)

List all available components for the given unity version in the current platform.

Parameters:

version - the version of unity to list components from

Returns:

a Components[] containing the requested components

readUnityVersion

public static java.lang.String readUnityVersion(java.io.File installationLocation)

Return the version as String of the unity installation at the provided location or Null.

Parameters:

installationLocation - the path to the unity installation or Unity executable

Returns:

a version string or null