### Unity Hub Initial Setup and Licensing Guide
Source: https://docs.unity3d.com/hub/manual/FTU
This section outlines the initial steps for first-time Unity users when launching the Unity Hub. It covers the introductory video, prompted Unity Editor installation, and the process of obtaining a personal license.
```html
First-time users
This page details how you can set up the Unity Hub once you install it onto your machine if you are a first-time user:
- When you first open the Hub application, it will display a short video that summarizes the updates and changes introduced in Version 3.0.
- After the video, the Hub will prompt you to install the Unity Editor.
Note: This will install the latest long-term support version of the Unity Editor. If you want a specific version, you can skip this step and go to the Add Editor page.
- The next page prompts you to get your first personal licence. You can also select Choose another plan if the displayed criteria don't apply. For more information, go to the Licenses page.
```
--------------------------------
### Install Unity Hub Beta on RHEL/CentOS
Source: https://docs.unity3d.com/hub/manual/InstallHub
Installs beta versions of the Unity Hub on RHEL or CentOS systems by adding a separate repository entry for unstable RPM packages.
```bash
sudo sh -c 'echo -e "[unityhub-beta]\nname=Unity Hub Beta\nbaseurl=https://hub.unity3d.com/linux/repos/rpm/unstable\nenabled=1\ngpgcheck=1\ngpgkey=https://hub.unity3d.com/linux/repos/rpm/unstable/repodata/repomd.xml.key\nrepo_gpgcheck=1" > /etc/yum.repos.d/unityhub_beta.repo'
```
```bash
sudo yum check-update
sudo yum install unityhub
```
--------------------------------
### Install Unity Hub Beta on Debian/Ubuntu
Source: https://docs.unity3d.com/hub/manual/InstallHub
Installs beta versions of the Unity Hub on Debian or Ubuntu systems by adding a separate repository entry for unstable packages.
```bash
sudo sh -c 'echo "deb [signed-by=/usr/share/keyrings/Unity_Technologies_ApS.gpg] https://hub.unity3d.com/linux/repos/deb unstable main" > /etc/apt/sources.list.d/unityhub-beta.list'
```
```bash
sudo apt update
sudo apt-get install unityhub=
```
--------------------------------
### Install Unity Hub on RHEL/CentOS
Source: https://docs.unity3d.com/hub/manual/InstallHub
Installs the Unity Hub on RHEL or CentOS-based Linux systems by adding the Unity Hub RPM repository, then updating the package cache and installing the package.
```bash
sudo sh -c 'echo -e "[unityhub]\nname=Unity Hub\nbaseurl=https://hub.unity3d.com/linux/repos/rpm/stable\nenabled=1\ngpgcheck=1\ngpgkey=https://hub.unity3d.com/linux/repos/rpm/stable/repodata/repomd.xml.key\nrepo_gpgcheck=1" > /etc/yum.repos.d/unityhub.repo'
```
```bash
sudo yum check-update
sudo yum install unityhub
```
--------------------------------
### Unity Hub Advanced Settings Link
Source: https://docs.unity3d.com/hub/manual/InstallHub
Provides a link to the Advanced Settings documentation for managing Unity Hub beta versions.
```html
Advanced Settings
```
--------------------------------
### Install Unity Hub on Debian/Ubuntu
Source: https://docs.unity3d.com/hub/manual/InstallHub
Installs the Unity Hub on Debian or Ubuntu-based Linux systems by adding the Unity Hub repository and GPG key, then updating the package list and installing the package.
```bash
wget -qO - https://hub.unity3d.com/linux/keys/public | gpg --dearmor | sudo tee /usr/share/keyrings/Unity_Technologies_ApS.gpg > /dev/null
```
```bash
sudo sh -c 'echo "deb [signed-by=/usr/share/keyrings/Unity_Technologies_ApS.gpg] https://hub.unity3d.com/linux/repos/deb stable main" > /etc/apt/sources.list.d/unityhub.list'
```
```bash
sudo apt update
sudo apt-get install unityhub
```
--------------------------------
### Download Unity Hub 3.12.1
Source: https://docs.unity3d.com/hub/manual/InstallHub
Direct download links for Unity Hub version 3.12.1 across different operating systems.
```APIDOC
Unity Hub 3.12.1 Downloads:
Windows x64:
https://public-cdn.cloud.unity3d.com/hub/3.12.0/UnityHubSetup.exe
macOS:
Intel (x64):
https://public-cdn.cloud.unity3d.com/hub/3.12.0/UnityHubSetup-x64.dmg
Apple Silicon (arm64):
https://public-cdn.cloud.unity3d.com/hub/3.12.0/UnityHubSetup-arm64.dmg
Linux:
RPM package:
https://public-cdn.cloud.unity3d.com/hub/3.12.0/unityhub-x86_64-3.12.1.rpm
DEB package:
https://public-cdn.cloud.unity3d.com/hub/3.12.0/unityhub-amd64-3.12.1.deb
```
--------------------------------
### Unity Hub Command Line Interface
Source: https://docs.unity3d.com/hub/manual/InstallHub
Provides access to the Unity Hub's command-line interface for advanced users. This allows for scripting and automation of Hub operations.
```APIDOC
Hub Command Line Interface:
Usage: UnityHubCLI [command] [options]
Commands:
install-editor [--module ,...] [--build ]
Installs a specific Unity Editor version with optional modules and build targets.
uninstall-editor
Uninstalls a specific Unity Editor version.
list-editors
Lists all installed Unity Editor versions.
install-hub
Installs a specific Unity Hub version.
update-hub
Updates the Unity Hub to the latest version.
Options:
--module: Specify modules to install with an Editor version (e.g., --module Android,iOS).
--build: Specify the build target for the Editor installation (e.g., --build android).
Example:
UnityHubCLI install-editor 2022.3.10 --module Android,WebGL --build android
```
--------------------------------
### Install Unity Hub on CentOS
Source: https://docs.unity3d.com/hub/manual/Help
Commands to install the stable version of Unity Hub on CentOS by disabling the beta repository and then installing or querying specific versions.
```bash
$ sudo mv /etc/yum.repos.d/unityhub_beta.repo /etc/yum.repos.d/unityhub_beta.repo.bak
$ sudo yum check-updates
$ sudo yum install unityhub
```
```bash
$ sudo yum list unityhub
$ sudo yum install unityhub-
```
--------------------------------
### Install Unity Modules
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to download and install modules to an already installed Unity Editor.
```APIDOC
Unity Hub CLI - Install Modules
Command: `install-modules` (alias: `im`)
Purpose: Downloads and installs modules to an installed Unity Editor.
Options:
--version, -v (Required): Specifies the version of the installed Editor to add the module to (e.g., `2022.1.1f1`).
--module, -m (Required): Specifies the module ID to install. You can add more than one module at a time (e.g., `android`, `appletv webgl`).
--childModules, --cm (Optional): Automatically selects and downloads all child modules for the specified modules.
Available Modules:
Documentation: `documentation`
Android Build Support: `android`
Android SDK & NDK Tools: `android-sdk-ndk-tools`
OpenJDK: `android-open-jdk`
iOS Build Support: `ios`
tvOS Build Support: `appletv`
Linux Build Support (Mono): `linux-mono`
Linux Build Support (IL2CPP): `linux-il2cpp`
WebGL Build Support: `webgl`
Windows Build Support: `windows`
Vuforia Augmented Reality support: `vuforia-ar`
Language packs: `language-ja`, `language-ko`, `language-zh-cn`, `language-zh-hant`, `language-zh-hans`
Windows Build Support (Mono): `windows-mono`
Lumin OS (Magic Leap) Build Support: `lumin`
Microsoft Visual Studio Community 2017/2019: `visualstudio`
Visual Studio for Mac: `visualstudio`
Mac Build Support (Mono): `mac-mono`
Mac Build Support (IL2CPP): `mac-il2cpp`
Universal Windows Platform Build Support: `universal-windows-platform`
UWP Build Support (IL2CPP): `uwp-il2cpp`
UWP Build Support (.NET): `uwp-.net`
Note: Not all modules are available for every version of the Editor or for every OS.
```
--------------------------------
### Unity Hub CLI Install Path Management
Source: https://docs.unity3d.com/hub/manual/HubCLI
Allows setting or getting the directory where Unity Editors are installed. If no option is specified, it defaults to getting the current install path.
```APIDOC
Unity Hub CLI Install Path Commands:
install-path [--set | -s ] [--get | -g]
Description:
Manages the installation path for Unity Editors.
Options:
--set, -s : Sets the install path to the specified directory.
--get, -g : Displays the current install path.
Default Behavior:
If neither --set nor --get is provided, the command defaults to --get.
Examples:
# Get current install path
unityhub -- --headless install-path
unityhub -- --headless install-path --get
unityhub -- --headless install-path -g
# Set install path
unityhub -- --headless install-path --set "C:\UnityEditors"
unityhub -- --headless install-path -s "/Applications/Unity/Hub/Editor"
```
--------------------------------
### Unity Hub Installation Path
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to specify the installation path for Unity Hub across different operating systems.
```bash
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install-path
-s /Applications/Unity/Hub/Editor/
```
```bash
C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install-path
-s /Applications/Unity/Hub/Editor/
```
```bash
~/Applications/Unity\ Hub.AppImage --headless install-path
-s /Applications/Unity/Hub/Editor/
```
--------------------------------
### Unity Hub Command Line Interface (CLI)
Source: https://docs.unity3d.com/hub/manual/InstallEditors
Documentation for the Unity Hub Command Line Interface, detailing commands for managing Unity installations and projects.
```APIDOC
Hub CLI:
Manages Unity installations and projects from the command line.
Commands:
--version
Prints the Unity Hub version.
--list
Lists all installed Unity Editor versions.
--install
Installs a specific Unity Editor version.
Example: --install 2022.3.10f1
--uninstall
Uninstalls a specific Unity Editor version.
Example: --uninstall 2022.3.10f1
--add-project
Adds an existing project to the Unity Hub.
Example: --add-project "C:\MyUnityProject" 2022.3.10f1
--open-project
Opens a project using the default Unity Editor version.
Example: --open-project "C:\MyUnityProject"
--create-project
Creates a new project.
Example: --create-project "NewGame" "C:\Projects" "3d" 2022.3.10f1
--help
Displays help information for the Hub CLI.
```
--------------------------------
### Configuring Exploit Protection for Unity Installer (Windows)
Source: https://docs.unity3d.com/hub/manual/Help
This guide explains how to configure Windows Exploit Protection settings to allow the Unity installer to run correctly, specifically addressing issues with Mandatory ASLR. It involves overriding system settings for specific Unity executable files.
```powershell
1. Go to Windows Security > App & browser control > Exploit protection settings > Program settings.
2. To add a program to customize, do one of the following:
* Select Add by program name to add a program with the executable file name. For example, file names can include UnityDownloadAssistant-2019.2.12f1.exe or UnitySetup64.exe.
* Select Choose exact file path to navigate to the executable file of the program you want to add.
3. In the Program Settings window, go to the Force randomization for images (Mandatory ASLR) section.
4. Select Override system settings.
5. Enable Override System Settings.
6. Select Apply.
7. Repeat this process for all versions of the Unity installer.
```
--------------------------------
### Cookie Settings Link
Source: https://docs.unity3d.com/hub/manual/InstallHub
A JavaScript link to open cookie settings, likely for privacy management.
```javascript
javascript:void(0);
```
--------------------------------
### Unity Hub CLI Help Commands
Source: https://docs.unity3d.com/hub/manual/HubCLI
Displays a list of available CLI commands, flags, and argument types for the Unity Hub. Examples are provided for different operating systems.
```bash
# macOS
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless help
# Windows
C:\Program Files\Unity Hub> "Unity Hub.exe" -- --headless help
# Linux
~/Applications/Unity\ Hub.AppImage --headless help
```
--------------------------------
### Installing Stable Unity Hub on Debian
Source: https://docs.unity3d.com/hub/manual/Help
This snippet demonstrates how to install the stable version of the Unity Hub on Debian-based Linux distributions when both stable and unstable repositories are configured. It involves disabling the beta repository and then performing the installation.
```bash
sudo mv /etc/apt/sources.list.d/unityhub-beta.list /etc/apt/sources.list.d/unityhub-beta.list.bak
sudo apt update
sudo apt-get install unityhub
```
```bash
sudo apt-get install unityhub=3.x.x
```
--------------------------------
### Unity Hub Command Line Interface (CLI)
Source: https://docs.unity3d.com/hub/manual/LoggingIn
Provides commands for managing Unity installations and projects from the command line. This includes installing/uninstalling editors, adding modules, and managing projects.
```APIDOC
Unity Hub CLI:
General Commands:
unityhub -- --help
Displays help information for the Unity Hub CLI.
Editor Management:
unityhub -- --editor --list
Lists all installed Unity Editor versions.
unityhub -- --editor --install
Installs a specified Unity Editor version.
Parameters:
version: The version string of the Unity Editor to install (e.g., "2021.3.10f1").
unityhub -- --editor --uninstall
Uninstalls a specified Unity Editor version.
Parameters:
version: The version string of the Unity Editor to uninstall.
unityhub -- --editor --add-module [module_name ...]
Adds modules to an installed Unity Editor version.
Parameters:
version: The version string of the Unity Editor.
module_name: The name of the module to add (e.g., "windowsbuildsupport-il2cpp").
Project Management:
unityhub -- --project --add
Adds an existing project to the Unity Hub.
Parameters:
project_path: The absolute or relative path to the project folder.
unityhub -- --project --open
Opens a project using the default Unity Editor version.
Parameters:
project_path: The absolute or relative path to the project folder.
unityhub -- --project --remove
Removes a project from the Unity Hub's project list.
Parameters:
project_path: The absolute or relative path to the project folder.
Note: The `--` is used to pass arguments to the Unity Hub executable itself, separating them from any arguments passed to a Unity Editor instance.
```
--------------------------------
### Fix Unity Hub Debian Installation Error: Missing sources.list.d
Source: https://docs.unity3d.com/hub/manual/Help
Commands to manually create the /etc/apt/sources.list.d directory and the unityhub.list file to resolve the 'No such file or directory' error during Debian package installation.
```bash
$ sudo mkdir /etc/apt/sources.list.d
$ sudo touch /etc/apt/sources.list.d/unityhub.list
```
--------------------------------
### Install Unity Editors
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to install a specific Unity Editor version, optionally with a changeset and modules.
```APIDOC
Unity Hub CLI - Install Editor
Command: `install` (alias: `i`)
Purpose: Installs a new Unity Editor version from the releases list or archive.
Options:
--version, -v (Required): The Editor version to install (e.g., `2022.1.1f1`).
--changeset, -c (Optional): The changeset of the Unity Editor if the version isn't in the release list (e.g., `9b001d489a54`).
--module, -m (Optional): The module ID to install. Accepts multiple module IDs (e.g., `android`, `appletv webgl`). Refer to `install-modules` for more information.
--childModules, --cm (Optional): Automatically selects and downloads all child modules for the specified modules.
--architecture, -a (Optional, macOS only): Explicitly choose between Apple Silicon (`arm64`) or Intel (`x86_64`) versions of the Unity Editor. Defaults to Intel (`x86_64`).
Examples:
macOS: /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install --version 2019.1.11f1 --changeset 9b001d489a54
Windows: C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install --version 2019.1.11f1 --changeset 9b001d489a54
Linux: ~/Applications/Unity\ Hub.AppImage --headless install --version 2019.1.11f1 --changeset 9b001d489a54
```
--------------------------------
### Unity Hub CLI Commands
Source: https://docs.unity3d.com/hub/manual/Learn
Provides access to the Unity Hub's Command Line Interface (CLI) for advanced users to automate tasks and manage Unity installations and projects.
```APIDOC
Hub Command Line Interface:
Access to the Unity Hub's Command Line Interface (CLI) for advanced users.
Refer to: https://docs.unity3d.com/hub/manual/HubCLI.html
```
--------------------------------
### Install Unity Modules (Windows)
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to install iOS and Android modules for Unity version 2019.1.11f1 using the Unity Hub CLI on Windows.
```batch
C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install-modules --version 2019.1.11f1 -m ios android
```
--------------------------------
### Unity Hub Command Line Interface (CLI)
Source: https://docs.unity3d.com/hub/manual/DownloadManager
The Unity Hub provides a command-line interface for automating tasks such as installing Unity Editor versions, managing projects, and handling licenses. This section details the available commands and their usage.
```APIDOC
Hub CLI:
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
```
--------------------------------
### Add Modules to Unity Editor
Source: https://docs.unity3d.com/hub/manual/AddModules
Step-by-step guide on how to add modules to an existing Unity Editor installation using the Unity Hub. This process allows users to customize their installation with specific platform build support, language packs, and development tools.
```en
1. In the Hub, go to **Installs**.
2. Right-click on or select the gear icon to open the contextual menu.
3. Select **Add modules** to open a window that lists all of the platform Build Support, language packs, and development tools that you can install. For modules that are already installed for that version, the **DOWNLOAD SIZE** column displays the word **Installed**.
4. To view the memory space required to install a module, select it. The top right of the window displays the information. This indicator also displays how much space is available on the install path you have selected.
5. Select the modules.
6. Select **Install**.
##### Note
Some modules require you to accept the Terms & Conditions before you can install them.
```
--------------------------------
### Remove Unity Hub from RHEL/CentOS
Source: https://docs.unity3d.com/hub/manual/InstallHub
Removes the Unity Hub package from RHEL or CentOS-based Linux systems.
```bash
sudo yum remove unityhub
```
--------------------------------
### Unity Hub CLI Manage Editors
Source: https://docs.unity3d.com/hub/manual/HubCLI
Lists available Unity Editor releases and installed versions. Options allow filtering to show all, only releases, or only installed editors.
```bash
# macOS
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless editors -r
# Windows
C:\Program Files\Unity Hub> "Unity Hub.exe" -- --headless editors -r
# Linux
~/Applications/Unity\ Hub.AppImage --headless editors -r
```
--------------------------------
### Remove Unity Hub from Debian/Ubuntu
Source: https://docs.unity3d.com/hub/manual/InstallHub
Removes the Unity Hub package from Debian or Ubuntu-based Linux systems.
```bash
sudo apt-get remove unityhub
```
--------------------------------
### Install Unity Editor via Unity Hub
Source: https://docs.unity3d.com/hub/manual/AddEditor
Steps to install a Unity Editor version through the Unity Hub interface. This includes navigating to the Installs section, selecting 'Install Editor', choosing a version, and selecting modules.
```unityhub
1. Install the Hub if you haven't done so.
2. Go to **Installs** in the left sidebar.
3. Select **Install Editor**.
4. Select **Install** for the desired version.
5. Select any modules you want.
6. Select **Install**.
```
--------------------------------
### Install Unity Modules (Linux)
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to install iOS and Android modules for Unity version 2019.1.11f1 using the Unity Hub CLI on Linux.
```bash
~/Applications/Unity\ Hub.AppImage --headless install-modules --version 2019.1.11f1 -m ios android
```
--------------------------------
### Unity Hub Command Line Interface (CLI)
Source: https://docs.unity3d.com/hub/manual/Community
This section details the commands available for the Unity Hub's Command Line Interface. It covers various operations for managing Unity installations, projects, and licenses directly from the terminal.
```APIDOC
Unity Hub CLI:
This documentation outlines the available commands for interacting with the Unity Hub via the command line.
General Usage:
unityhub [options]
Commands:
1. install-editor
Installs a specific Unity Editor version.
Usage: install-editor --version [--changeset ] [--modules ]
Parameters:
--version: The Unity Editor version to install (e.g., "2021.3.10f1"). Required.
--changeset: The specific changeset for the version. Optional.
--modules: A comma-separated list of modules to install with the editor (e.g., "windows-support,android-build-support"). Optional.
2. uninstall-editor
Uninstalls a specific Unity Editor version.
Usage: uninstall-editor --version
Parameters:
--version: The Unity Editor version to uninstall. Required.
3. install-module
Adds modules to an existing Unity Editor installation.
Usage: install-module --editor-version --modules
Parameters:
--editor-version: The Unity Editor version to add modules to. Required.
--modules: A comma-separated list of modules to install (e.g., "documentation-zh-cn,visual-studio-editor"). Required.
4. uninstall-module
Removes modules from an existing Unity Editor installation.
Usage: uninstall-module --editor-version --modules
Parameters:
--editor-version: The Unity Editor version to remove modules from. Required.
--modules: A comma-separated list of modules to remove. Required.
5. add-project
Adds an existing project to the Unity Hub.
Usage: add-project --project-path
Parameters:
--project-path: The absolute or relative path to the Unity project folder. Required.
6. remove-project
Removes a project from the Unity Hub's project list.
Usage: remove-project --project-path
Parameters:
--project-path: The path to the Unity project to remove. Required.
7. open-project
Opens a Unity project using the Hub.
Usage: open-project --project-path [--editor-version ]
Parameters:
--project-path: The path to the Unity project to open. Required.
--editor-version: The specific Unity Editor version to use for opening the project. If not provided, the Hub's default or last used version will be used. Optional.
8. list-editors
Lists all installed Unity Editor versions.
Usage: list-editors
9. list-projects
Lists all projects currently managed by the Unity Hub.
Usage: list-projects
10. activate-license
Activates a Unity license.
Usage: activate-license --serial-number
Parameters:
--serial-number: The Unity serial number for activation. Required.
11. deactivate-license
Deactivates the current Unity license.
Usage: deactivate-license
12. get-license-status
Retrieves the status of the current Unity license.
Usage: get-license-status
Error Handling:
- The CLI will provide feedback on command success or failure.
- Specific error messages will indicate issues like invalid paths, missing versions, or network problems during license activation.
```
--------------------------------
### Locate Editor Program File
Source: https://docs.unity3d.com/hub/manual/AddEditor
Instructions on how to find the installation path of a Unity Editor via the Unity Hub.
```unityhub
1. Open the Unity Hub.
2. Select **Installs** in the left sidebar.
3. Identify the specific Editor in the list of installs, and take note of its location.
4. Use your operating system's file management application to go to the location you identified.
**Note:** You can also select the gear icon to open the contextual menu and select **Show in Explorer** (Windows) or **Reveal in Finder** (macOS).
On macOS, when you get to the `Unity.app` file, right-click it and select **Show Package Contents** to see the full application structure.
```
--------------------------------
### Install Unity Modules (macOS)
Source: https://docs.unity3d.com/hub/manual/HubCLI
Command to install iOS and Android modules for Unity version 2019.1.11f1 using the Unity Hub CLI on macOS.
```bash
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install-modules --version 2019.1.11f1 -m ios android
```
--------------------------------
### Unity Hub Command Line Interface (CLI)
Source: https://docs.unity3d.com/hub/manual/Projects
Provides commands for interacting with the Unity Hub from the command line. This allows for automation of tasks such as project management and editor installations.
```unityhubcli
Unity Hub CLI:
Usage: UnityHubCLI [command] [options]
Commands:
install-editor [--modules ,]
Installs a specific Unity Editor version with optional modules.
list-editors
Lists all installed Unity Editor versions.
open-project
Opens a Unity project in the associated Unity Editor.
create-project
Creates a new Unity project using a specified template.
remove-project
Removes a project from the Unity Hub.
Options:
--modules
Specifies modules to install with an editor version (e.g., --modules android,webgl).
Examples:
UnityHubCLI install-editor 2022.3.10f1 --modules android,ios
UnityHubCLI open-project "C:\MyUnityProjects\MyGame"
UnityHubCLI list-editors
```
--------------------------------
### Unity Hub Project Templates
Source: https://docs.unity3d.com/hub/manual/Templates
Details on core project templates available in Unity Hub, including their purpose and supported platforms. These templates streamline project setup.
```APIDOC
Core Templates:
Template Name: 2D
Function: Configures project settings for 2D applications using Unity's Built-In Render Pipeline.
Platforms Supported: iOS, Android, Linux, macOS, WebGL, Windows
Template Name: 3D
Function: Configures project settings for 3D applications using Unity's Built-In Render Pipeline.
Platforms Supported: iOS, Android, Linux, macOS, WebGL, Windows
Template Name: VR
Function: Configures settings for a Virtual Reality application, including a sample scene, assets, and recommended packages.
Platforms Supported: Windows
Template Name: VR Multiplayer
Function: Configures settings for a Virtual Reality application with multiplayer functionality, including a sample scene, assets, and recommended packages.
Platforms Supported: Android, Windows
Template Name: MR
Function: Configures project settings, pre-installs required packages, and includes example assets for Mixed Reality projects.
Platforms Supported: Android, Windows
Template Name: MR Multiplayer
Function: Configures a project for Mixed Reality with multiplayer functionality, including a sample scene, assets, and recommended packages.
Platforms Supported: Android, Windows
Template Name: AR
Function: Configures settings for an Augmented Reality application, including a sample scene, assets, and recommended packages.
Platforms Supported: iOS, Android
Template Name: 3D Mobile
Function: Configures settings for 3D mobile development using recommended packages.
Platforms Supported: iOS, Android
Template Name: 2D Mobile
Function: Configures settings for 2D mobile development using recommended packages.
Platforms Supported: iOS, Android
To create a project:
1. Select the 'Projects' tab in Unity Hub.
2. Select 'New project'.
3. Choose a template from the 'New project' window.
4. Select 'Read more' to view template details, including packages.
5. Navigate to the 'Packages' tab within the template dialog.
```
--------------------------------
### Install Archived Unity Editor Version
Source: https://docs.unity3d.com/hub/manual/AddEditor
Instructions for installing Unity Editor versions not directly listed in the Hub, by accessing the download archive.
```unityhub
1. Go to **Archive**.
2. Select the link for the download archive.
3. To install versions 5.6.0 and up and add them to the Hub, select **Unity Hub**.
4. In the window that opens, select **Install** to install your chosen Editor version and modules.
```
--------------------------------
### Install New Unity Editor Version
Source: https://docs.unity3d.com/hub/manual/OpenProject
Enables users to download and install new versions of the Unity Editor directly through the Unity Hub. This is typically accessed via a modal dialog when selecting to open a project with a different Editor version.
```APIDOC
Editor Installation:
InstallEditor(version: string, modules?: string[])
Initiates the download and installation of a specified Unity Editor version.
Parameters:
version: The target Unity Editor version string to install (e.g., "2022.2.0b1").
modules: An optional array of module names to install along with the Editor (e.g., ["Windows Build Support", "Android Build Support"]).
Returns:
void
Notes:
- This action is typically performed through the Unity Hub's UI, often initiated from the 'Install Editor version' button within the project opening modal.
- Requires an active internet connection for downloading.
- Installation progress is usually displayed in the Hub's downloads manager.
```
--------------------------------
### Unity Hub Settings Configuration
Source: https://docs.unity3d.com/hub/manual/Settings
This section outlines the various settings available in the Unity Hub for managing projects, installations, appearance, licenses, and update channels. It details the purpose of each setting and provides default locations where applicable.
```APIDOC
Settings Reference:
Projects:
Specify the target directory where the Hub creates a new project.
Installs:
Specify the target directory for Editor and Learn installations and downloads.
- Installs location: Select a location for Editor and Learn installations. Default locations:
- macOS: /Applications/Unity/Hub/Editor
- Windows: C:\Program Files\Unity\Hub\Editor
- Linux: /home/Unity/Hub/Editor
- Downloads location: Select a location for Editor and Learn downloads. Default: the `temp` directory.
Appearance:
Change the appearance of the Hub.
- Theme: Select a light or dark theme.
- Menu bar: Hide the Hub application from view when you open the Unity Editor.
- Language: Select the display language.
Licenses:
Add, return, and view licenses.
Advanced:
Choose whether to receive Hub updates from the Production or Beta release channel.
```
--------------------------------
### Add Manually Downloaded Editor
Source: https://docs.unity3d.com/hub/manual/AddEditor
Steps to add a Unity Editor version that has been downloaded manually to the Unity Hub.
```unityhub
1. Select **Locate**.
2. Browse to locate your file.
3. Select **Select Editor** to add it to the Hub.
```
--------------------------------
### Unity Hub Troubleshooting Guide
Source: https://docs.unity3d.com/hub/manual/WorkOffline
This section outlines common Unity Hub issues and their corresponding solutions or workarounds. It covers problems related to the 'Work offline' button, license validation, and package management.
```text
Symptom | Action or possible workaround
---|---
The **Work offline** button is disabled and has a warning icon. | Hover over **Work offline** to view a message that displays a possible cause.
Your project fails to open while not connected to the internet. | Check if the **Work offline** button displays with a plus sign, or is disabled with a warning icon. If so, you might not have a valid license. Connect to your enterprise network and borrow a license.
Your project fails to open and the **Work offline** button shows a clock icon. | Your project needs packages that might be missing on your computer. Connect to your enterprise network and open your project. Wait for all packages to download, then try again.
```
--------------------------------
### Uninstall Editor Version
Source: https://docs.unity3d.com/hub/manual/AddEditor
Procedure for uninstalling a Unity Editor version from the Unity Hub.
```unityhub
1. Right-click the version or select the gear icon to open the contextual menu.
2. Select **Uninstall** from the dropdown.
The uninstall option is applicable for Editor versions that you installed through the Hub. For versions of the Editor that you installed manually and located through the Hub, you can select **Remove** to remove the version from the Hub, but this leaves the files on your disk. To remove the files, you need to navigate to the file path of the Editor and manually delete the Editor folder.
```
--------------------------------
### Open Project with Specific Editor Version
Source: https://docs.unity3d.com/hub/manual/OpenProject
Allows users to open a Unity project using a specific installed version of the Unity Editor, overriding the default. This is useful for compatibility testing or working with projects that require a particular Editor version.
```APIDOC
Project Management:
OpenProject(projectPath: string, editorVersion: string)
Opens a Unity project located at the specified path using the given Unity Editor version.
Parameters:
projectPath: The absolute or relative path to the Unity project folder.
editorVersion: The specific version string of the Unity Editor to use (e.g., "2021.3.10f1").
Returns:
void
Notes:
- A warning may appear if the selected Editor version might cause issues with the project.
- The specified editorVersion must be installed via the Unity Hub.
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.