Skip to main content

Setup and Installation

This page walks you through importing LuminousOasis into a new Unity project and reaching the point where the scene opens correctly.

Required environment​

  • Unity 2022.3 LTS
  • VRChat Creator Companion
  • VRChat SDK3 Worlds
  • TextMeshPro
  • VRC Light Volumes

1. Install VCC and create a new project​

Install Creator Companion from the VRChat website and create a new project for worlds.

Do not install into an existing LuminousHotel project from before version 2.0

LuminousOasis is not compatible with older LuminousHotel projects from before version 2.0. Installing it there can break the scene or its saved settings. Always create a new project first when using LuminousOasis.

Creator Companion download screen
Creator Companion project creation screen

Creating a new project is recommended over adding the asset to an existing one. In particular, avoid adding it to a project that already contains LuminousHotel from before version 2.0. After creating the project, open Unity with Open Project.

Start from a new project

Do not add it to an existing project. Set it up from a fresh project.

Choose the settings intended for worlds and click Create Project. The exact wording may change when VRChat updates VCC.

Open Project button location

2. Add VRC Light Volumes​

LuminousOasis uses VRC Light Volumes. Register it in VCC and import it into the target project before continuing.

  1. Open VPM Listing
  2. Click Add to VCC to register it with Creator Companion
  3. Open Manage Project for the target project
  4. Add VRC Light Volumes from Manage Packages
  5. Check the Installed Version and import it
Adding VRC Light Volumes from VPM Listing
Manage Project button location
Checking VRC Light Volumes in Manage Packages

Once that is done, the prerequisites are complete.

3. Import the UnityPackages​

Import the required UnityPackages based on how you plan to use the asset.

Using LuminousOasis by itself​

  • LuminousOasis

Using it together with LuminousHotel​

  • Condominium_701
  • SimpleRoom_702
  • LuminousHotel_FullPack
  • LuminousOasis

When combining it with LuminousHotel, only the Full Pack setup is supported. Import the hotel-side packages first, then import LuminousOasis.unitypackage.

Tip

When using LuminousOasis together with LuminousHotel, only the Full Pack configuration is supported.

If pink shader errors appear

If you imported into an existing project, duplicate shaders may be causing the issue. Delete one of the conflicting shaders or create a new project.

4. Import TextMeshPro Essentials​

If the TMP Importer appears after import, run Import TMP Essentials.

TMP Importer dialog

This package is required for text rendering. If you imported it after opening the scene, try reopening the scene.

If you closed the TMP window, open Package Manager from Window and install TextMeshPro from the Unity Registry.

Installing TextMeshPro from Package Manager

5. Open the scene​

Open the scene by double-clicking it in the Project window. If you drag and drop it, Unity treats it as a multi-scene setup and the project will not be configured correctly.

Open scenes by double-clicking

Dragging and dropping a scene causes Unity to treat it as a multi-scene setup and prevents correct configuration.

LuminousOasis only​

Assets/QuickBrown/LuminousOasis/SCENE/LuminousOasis.unity

Location of the standalone LuminousOasis scene
Overview of the standalone LuminousOasis scene

Using it together with LuminousHotel​

Assets/QuickBrown/LuminousHotel/FullPack_OasisPlus/SCENE/FullPack_OasisPlus.unity

Location of the FullPack_OasisPlus scene
Overview of the FullPack_OasisPlus scene

Next page​

Continue to Initial Scene Setup to configure RoomOwner and BGM.