Jasima/lvra.gitlab.io
1
0
Fork 0
mirror of https://gitlab.com/lvra/lvra.gitlab.io.git synced 2024-12-26 15:50:25 +01:00
Code Issues Projects Releases Packages Wiki Activity

Overhaul unity.md in favor of ALCOM

Browse source
This commit is contained in:
libjared 2024-05-28 03:26:40 +00:00
parent d1ec731ffc
commit f2a92cf2c4
1 changed files with 24 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
content/docs/vrchat/unity.md
View file

@ -5,39 +5,39 @@ title: Unity
# Unity # Unity
For the best experience, we found that running Unity from [Flatpak](https://flathub.org/apps/com.unity.UnityHub) is usually preferred. This article will take you through installing Unity Hub, Unity, and ALCOM (the FOSS alternative to VRChat Creator Companion).
You have two options for setting up VRChat avatar/world projects: ## Set up UnityHub
1. vrc-get CLI, a native FOSS package manager written in Rust
2. LinuxCreatorCompanion GUI, which runs VRChat Creator Companion with Linux-specific patches
## Option 1. vrc-get Download the [UnityHub AppImage](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHub.AppImage). Run the AppImage like you normally would.
First, take a look at this page from [the official VRChat docs](https://creators.vrchat.com/sdk/upgrade/unity-2022/#using-the-unity-website) about the Unity 2022 upgrade. We'll do something similar. Running UnityHub from [Flatpak](https://flathub.org/apps/com.unity.UnityHub) is also still an option, but it seems ALCOM has better integration with the AppImage.
First, take a look at this page from [the official VRChat docs](https://creators.vrchat.com/sdk/upgrade/unity-2022/#using-the-unity-hub) about how to install the supported Unity version from UnityHub. We'll do something similar.
1. Install Unity Hub from Flatpak.
1. Install the 3rd party VRChat package manager [`vrc-get`](https://github.com/anatawa12/vrc-get).
- You can install via `cargo install vrc-get`.
- Or, install this AUR package: [`vrc-get` AUR](https://aur.archlinux.org/packages/vrc-get).
- Or, you can run the binary from the releases page.
1. Open Unity Hub and sign in with your Unity account. 1. Open Unity Hub and sign in with your Unity account.
1. Install **2022.3.6f1** (the current supported Unity version, at the time of writing) by running `xdg-open unityhub://2022.3.6f1/b9e6e7e9fa2d`. 1. Install **2022.3.22** (VRChat's current supported Unity version, at the time of writing) by running `./UnityHub.AppImage unityhub://2022.3.22f1/887be4894c44`.
1. When prompted, select *Android Build Support* and *Windows Build Support (Mono)*. 1. When prompted, select *Android Build Support* and *Windows Build Support (Mono)*.
1. Create a new project with the **3D Core template**, making sure to name it and give it a better location than `$HOME`.
1. It may open windows partially offscreen. If this happens, see [this section](#editor-windows-appear-partially-offscreen). ## ALCOM
1. Close the Unity project (will probably crash later if you don't, no big deal but still).
1. Open terminal and `cd` to the project dir. 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).
1. Run either `vrc-get install com.vrchat.avatars` or `vrc-get install com.vrchat.worlds` depending on what you will be making.
1. Reopen the Unity project and it will import the new packages. 1. Download the [AppImage from the latest "gui" release](https://github.com/vrc-get/vrc-get/releases). Pick the file named `alcom-<some version>-x86_64.AppImage`.
1. Run the AppImage.
1. In the settings tab, under Unity Hub Path, point it to your UnityHub.AppImage.
1. Create a new project and open it.
1. Go to VRChat SDK -> Show Control Panel and dock it to the main window. 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. Now you should be able to create and upload avatars and worlds like you normally would.
If you're having issues, see the [Troubleshooting](#troubleshooting) section. <!--
This is no longer maintained.
## Option 2. LinuxCreatorCompanion ## Option 2. LinuxCreatorCompanion
If you prefer GUIs, it is now possible to use VRChat Creator Companion (VCC) on Linux. If you need some of the GUIs, it is now possible to use VRChat Creator Companion (VCC) on Linux.
The official VRChat Creator Companion uses Webview2 (Microsoft Edge). This component is difficult to install, and doesn't run natively. Instead, you can use LinuxCreatorCompanion. The official VRChat Creator Companion uses Webview2 (Microsoft Edge). This component is difficult to install, and doesn't run natively. Instead, you can use LinuxCreatorCompanion.
@ -54,15 +54,16 @@ To install, click the releases tab, download the zip, extract it somewhere, and
exec flatpak run com.unity.UnityHub "$@" exec flatpak run com.unity.UnityHub "$@"
``` ```
-->
## Troubleshooting ## Troubleshooting
### AssetBundle was not built ### Worlds: AssetBundle was not built
When building and uploading, this error message may appear. It's caused by VRCSDK building an AssetBundle whose filename has mixed caps, when Unity AssetBundles are really only supposed to have lowercase filenames. When building and uploading, this error message may appear. It's caused by VRCSDK building an AssetBundle whose filename has mixed caps, when Unity AssetBundles are really only supposed to have lowercase filenames.
To fix this, import `WorldSDKPatch.unitypackage`: https://github.com/thegu5/VRCSDKonLinux/releases To fix this, import `WorldSDKPatch.unitypackage`: https://github.com/thegu5/VRCSDKonLinux/releases
### Shaders fail to include some .cginc files ### Shaders fail to include some .cginc files
This can happen with Poiyomi. It's caused by case-sensitivity. You may need to edit the shader files directly. Open them in any text editor, and correct the casing of filenames. This can happen with Poiyomi. It's caused by case-sensitivity. You may need to edit the shader files directly. Open them in any text editor, and correct the casing of filenames.
@ -72,7 +73,7 @@ This can happen with Poiyomi. It's caused by case-sensitivity. You may need to e
Unity may open undocked panel windows (such as color pickers and unitypackage import dialogs) partially offscreen. Unity may open undocked panel windows (such as color pickers and unitypackage import dialogs) partially offscreen.
Some workarounds: Some workarounds:
- For KDE, hold the Super key and click anywhere in the window to drag it back onscreen. - For KDE, hold the Meta key and click anywhere in the window to drag it back onscreen.
- For KDE, press ALT+F3 -> More Actions -> Move. - For KDE, press ALT+F3 -> More Actions -> Move.
### Drag-and-drop does not work ### Drag-and-drop does not work