From 7b90c31a5f26857d9776d10dbb449a6b507b0f58 Mon Sep 17 00:00:00 2001 From: Etch9 Date: Sat, 17 May 2025 20:32:51 +0000 Subject: [PATCH 1/5] Draft: talk about other installations --- content/docs/vrchat/unity.md | 37 ++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index 2128675..d2debac 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 many ways:(TODO) + +### 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,23 @@ 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 (Only Pro and Plus licenses) +You can download the tar from [here](https://unity.com/releases/editor/archive) after that extract the contents in a folder of your choosing (make sure the folder structure remains untouched). +afterwords you can activate your unity installation with the following command: +`.Editor/Unity -quit -batchmode -serial XX-XXXX-XXXX-XXXX-XXXX-XXXX -username 'yourUnity@mail.com' -password 'XXXXXXX'` + +To Open a project in Unity simply run: +` ./Editor/Unity -projectPath /path/to/your/project ` + +To download Unity you can also use the following cli tool: https://github.com/Larusso/unity-version-manager + ## 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,8 +49,24 @@ 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). +### Flatpak +To use the flatpak you will have to provide the following bash script to Alcom instead of the Unity executable +``` +#!/bin/bash + +# Execute the Flatpak application with the provided arguments +flatpak run com.unity.UnityHub -- "$@" +``` + +and symlink the flatpak .config unity folder to the system's one: + +` ln ~/.var/app/com.unity.UnityHub/config/unity3d/Unity/licenses/ ~/.config/unity3d/Unity/licenses` + Now you should be able to create and upload avatars and worlds like you normally would. +### Standalone +To use the standalone version simply add to alcom the Unity executable of that editor version + \ No newline at end of file + +### Unity 2021 crashing +For unity 2021.3.x on linux, the following steps should be followed: (TODO: mention original forum post) + +install the correct version along with windows/linux build support. +go to ~/Unity/Hub/Editor/2021.3.xxxx/Editor/Data, (TODO:talk other paths) +rename bee_backend to bee_backend.bin, +create a new text file named bee_backend in the same directory, +mark it as executable (so chmod 755 bee_backend or use your file browser), +fill it with these contents:, + +#!/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 From 83f3e8745efbe1aafd674e63da2e996a002ca8d4 Mon Sep 17 00:00:00 2001 From: Etch9 Date: Sat, 17 May 2025 20:59:45 +0000 Subject: [PATCH 3/5] fix missing codeblock --- content/docs/vrchat/unity.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index 227b6f1..817704d 100644 --- a/content/docs/vrchat/unity.md +++ b/content/docs/vrchat/unity.md @@ -195,7 +195,7 @@ rename bee_backend to bee_backend.bin, create a new text file named bee_backend in the same directory, mark it as executable (so chmod 755 bee_backend or use your file browser), fill it with these contents:, - +``` #!/bin/bash args=("$@") @@ -207,4 +207,5 @@ do break;; esac done -${0}.bin "${args[@]}" \ No newline at end of file +${0}.bin "${args[@]}" +``` \ No newline at end of file From dad32c6c3371ed24e878bd7bdf14c05c703056c3 Mon Sep 17 00:00:00 2001 From: Etch9 Date: Sun, 18 May 2025 19:33:27 +0000 Subject: [PATCH 4/5] open ssl 1.1 --- content/docs/vrchat/unity.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index 817704d..5c60ad8 100644 --- a/content/docs/vrchat/unity.md +++ b/content/docs/vrchat/unity.md @@ -35,6 +35,8 @@ To Open a project in Unity simply run: To download Unity you can also use the following cli tool: https://github.com/Larusso/unity-version-manager +Note: if your system does not provide an open ssl 1.1 package you wont be able to use unity versions older than 2022 + ## 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). From addf05fc36cef9e91301bc9c3d4a9a93fe514d3c Mon Sep 17 00:00:00 2001 From: Etch9 Date: Sun, 25 May 2025 14:23:35 +0000 Subject: [PATCH 5/5] Write it better --- content/docs/vrchat/unity.md | 121 +++++++++++++++++++++++------------ 1 file changed, 80 insertions(+), 41 deletions(-) diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index 5c60ad8..0886646 100644 --- a/content/docs/vrchat/unity.md +++ b/content/docs/vrchat/unity.md @@ -9,7 +9,7 @@ This article will take you through installing Unity and ALCOM (the FOSS alternat ## Unity Installation: -There are many ways:(TODO) +There are several methods to install Unity, depending on your preferences and system setup: ### Using UnityHub @@ -25,17 +25,25 @@ First, take a look at this page from [the official VRChat docs](https://creators - 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 (Only Pro and Plus licenses) -You can download the tar from [here](https://unity.com/releases/editor/archive) after that extract the contents in a folder of your choosing (make sure the folder structure remains untouched). -afterwords you can activate your unity installation with the following command: -`.Editor/Unity -quit -batchmode -serial XX-XXXX-XXXX-XXXX-XXXX-XXXX -username 'yourUnity@mail.com' -password 'XXXXXXX'` +### Standalone Install (Pro and Plus Licenses Only) -To Open a project in Unity simply run: -` ./Editor/Unity -projectPath /path/to/your/project ` +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. -To download Unity you can also use the following cli tool: https://github.com/Larusso/unity-version-manager +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' + ``` -Note: if your system does not provide an open ssl 1.1 package you wont be able to use unity versions older than 2022 +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 @@ -52,22 +60,35 @@ vrc-get is a native FOSS package manager written in Rust. Its GUI counterpart wa 1. It may open windows partially offscreen. If this happens, see [this section below](#editor-windows-appear-partially-offscreen). ### Flatpak -To use the flatpak you will have to provide the following bash script to Alcom instead of the Unity executable -``` -#!/bin/bash -# Execute the Flatpak application with the provided arguments -flatpak run com.unity.UnityHub -- "$@" -``` +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 -and symlink the flatpak .config unity folder to the system's one: + # Execute the Flatpak application with the provided arguments + flatpak run com.unity.UnityHub -- "$@" + ``` -` ln ~/.var/app/com.unity.UnityHub/config/unity3d/Unity/licenses/ ~/.config/unity3d/Unity/licenses` +2. Make the script executable by running: + ```bash + chmod +x unity-flatpak.sh + ``` -Now you should be able to create and upload avatars and worlds like you normally would. +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 -To use the standalone version simply add to alcom the Unity executable of that editor version + +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. -### Unity 2021 crashing -For unity 2021.3.x on linux, the following steps should be followed: (TODO: mention original forum post) +### Unity 2021 Crashing -install the correct version along with windows/linux build support. -go to ~/Unity/Hub/Editor/2021.3.xxxx/Editor/Data, (TODO:talk other paths) -rename bee_backend to bee_backend.bin, -create a new text file named bee_backend in the same directory, -mark it as executable (so chmod 755 bee_backend or use your file browser), -fill it with these contents:, -``` -#!/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 +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