diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index 2128675..0886646 100644 --- a/content/docs/vrchat/unity.md +++ b/content/docs/vrchat/unity.md @@ -5,9 +5,13 @@ title: Unity # Unity -This article will take you through installing Unity Hub, Unity, and ALCOM (the FOSS alternative to VRChat Creator Companion). +This article will take you through installing Unity and ALCOM (the FOSS alternative to VRChat Creator Companion). -## Set up UnityHub + +## Unity Installation: +There are several methods to install Unity, depending on your preferences and system setup: + +### Using UnityHub Download the [UnityHub AppImage](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHub.AppImage). Run the AppImage like you normally would. @@ -20,10 +24,33 @@ First, take a look at this page from [the official VRChat docs](https://creators 1. When prompted, select *Android Build Support* and *Windows Build Support (Mono)*. - You may need to install `cpio` from your distro's repos in order to install these components (The AppImage erroneously doesn't include it). To check if it's installed, run `which cpio` in a terminal. + +### Standalone Install (Pro and Plus Licenses Only) + +You can download the Unity editor tar file from the [official Unity archive](https://unity.com/releases/editor/archive). After downloading, extract the contents into a folder of your choice, ensuring that the folder structure remains intact. + +1. To activate your Unity installation, open a terminal and run the following command, replacing the placeholders with your actual license serial number and Unity account credentials: + ```bash + ./Editor/Unity -quit -batchmode -serial XX-XXXX-XXXX-XXXX-XXXX-XXXX -username 'yourUnity@mail.com' -password 'XXXXXXX' + ``` + +2. To open a project in Unity, use the following command, replacing `/path/to/your/project` with the actual path to your project: + ```bash + ./Editor/Unity -projectPath /path/to/your/project + ``` + +Additionally, you can manage Unity versions using the command-line tool available at [unity-version-manager](https://github.com/Larusso/unity-version-manager). + +{{% hint info %}} +**Note:** If your system does not provide an OpenSSL 1.1 package, you will be unable to use Unity versions older than 2022. +{{% /hint %}} + ## ALCOM vrc-get is a native FOSS package manager written in Rust. Its GUI counterpart was formerly known as vrc-get-gui, but has been rebranded as ALCOM (***Al***ternative Creator ***Com***panion). +### AppImage + 1. Download the [AppImage from the latest "gui" release\*](https://github.com/vrc-get/vrc-get/releases). Pick the file named `alcom--x86_64.AppImage`. - \*Some users say the v0.16.0 and v1.0.0 releases only show a blank white GUI. If you're affected by this bug, downgrade to [v0.1.15](https://github.com/vrc-get/vrc-get/releases/tag/gui-v0.1.15) AppImage for the time being. 1. Run the AppImage. @@ -32,7 +59,36 @@ vrc-get is a native FOSS package manager written in Rust. Its GUI counterpart wa 1. Go to VRChat SDK -> Show Control Panel and dock it to the main window. 1. It may open windows partially offscreen. If this happens, see [this section below](#editor-windows-appear-partially-offscreen). -Now you should be able to create and upload avatars and worlds like you normally would. +### Flatpak + +1. To use the Flatpak version of Unity with ALCOM, create a bash script with the following content and save it as `unity-flatpak.sh`: + ```bash + #!/bin/bash + + # Execute the Flatpak application with the provided arguments + flatpak run com.unity.UnityHub -- "$@" + ``` + +2. Make the script executable by running: + ```bash + chmod +x unity-flatpak.sh + ``` + +3. In ALCOM, point the Unity executable to the `unity-flatpak.sh` script you just created. + +4. Next, create a symlink for the Flatpak Unity configuration folder to the system's Unity configuration folder by running: + ```bash + ln -s ~/.var/app/com.unity.UnityHub/config/unity3d/Unity/licenses/ ~/.config/unity3d/Unity/licenses + ``` + +### Standalone + +1. To use the standalone version of Unity with ALCOM, add the Unity executable for the specific editor version you have installed. + +2. Ensure that the Unity executable is correctly pointed to within ALCOM's settings. + + +Now you should be able to create and upload avatars and worlds as you normally would. \ No newline at end of file + +### Unity 2021 Crashing + +If you are experiencing crashes with Unity 2021.3.x on Linux, follow these steps to resolve the issue: + +1. Ensure you have installed the correct version of Unity along with both Windows and Linux build support. + +2. Navigate to the Unity editor installation directory: + ```bash + cd ~/Unity/Hub/Editor/2021.3.xxxx/Editor/Data + ``` + +3. Rename the `bee_backend` file to `bee_backend.bin` by running: + ```bash + mv bee_backend bee_backend.bin + ``` + +4. Create a new text file named `bee_backend` in the same directory: + ```bash + touch bee_backend + ``` + +5. Make the new `bee_backend` file executable: + ```bash + chmod 755 bee_backend + ``` + +6. Open the `bee_backend` file in a text editor and add the following script: + ```bash + #!/bin/bash + + args=("$@") + for ((i=0; i<"${#args[@]}"; ++i)) + do + case ${args[i]} in + --stdin-canary) + unset args[i]; + break;; + esac + done + ${0}.bin "${args[@]}" + ``` \ No newline at end of file