VRse Studio Unity Setup Guide

​

1. Prerequisites

• Unity Editor (2022 LTS or newer) installed
• Valid VRseBuilder platform credentials
• Network access to the VRseBuilder API endpoints

​

2. Unity Login and Project Selection

​

2.1 Logging Into VRseBuilder

1. Open Unity Editor
2. Navigate to VRseBuilder → Login from the Unity menu ba

1. Enter your VRseBuilder platform username and password
2. Click Login

​

2.2 Selecting Your Project

1. In the VRse Studio Projects window, locate the Project dropdown menu
2. Select your desired project from the list
3. The dropdown displays all projects associated with your Creator ID

Note: Project selection is required before proceeding with any development work.

​

3. Initial Project Setup

​

3.1 Module Creation Process

1. In the VRse Studio Projects window, choose the module you want to work with
2. Click the Create button

• Open Project Config: Provides access to project configuration settings (detailed in Section 4)
• No Art Scene Assigned: Used for assigning visual scenes (detailed in Section 7)

Assets/
├── StreamingAssets/
│   └── Story Files/
│       └── [Project Name]/
│           └── [Module Name]/
│               └── [Experience Name]/
└── StudioProjects/
    └── [Project Name]/
        └── Modules/
            └── [Module Name]/
                └── [Experience Name]/
                    └── DevScene/

​

4. Project Configuration

​

4.1 Accessing Project Configuration

• Opens automatically during initial project creation

• Navigate to VRseBuilder → Project Config from Unity menu

​

4.2 Configuration Sections

​

4.2.1 Login Access Settings

• PulseAPI URL: Backend API endpoint for your project
• Login Method: Authentication method (typically “DomainName”)

​

4.2.2 Text-to-Speech (TTS) Settings

• TTS Token (OpenAI Key): API key for OpenAI text-to-speech services
• Confirm auto-generated paths for Project Resource TTS Folder Path and Available File Path For TTS

​

4.2.3 Photon App Settings

• App Id Fusion: Application ID for Photon Fusion multiplayer services
• App Id Voice: Application ID for Photon Voice communication services
• Fixed Region (Optional): Preferred server region for network optimization

​

4.2.4 VRse Project Settings

• Company Name: Publisher/developer name for Unity build
• Product Name: Application name
• Package Naming Method: Choose “Auto-generate” or “Custom”

​

4.3 Final Configuration

1. After configuring all sections individually, click the large green Save and Apply All Settings button
2. This master control saves all settings and applies them to respective Unity components
3. Ensures complete and consistent project setup

​

5. Streamlined Project Switching

​

5.1 Switching Projects

1. Open the VRse Studio Projects window
2. Select a different project from the dropdown

• “Yes, Apply Settings”: Automatically applies all stored configurations (recommended)
• “No, I’ll Apply Manually”: Allows manual review and application of settings

Recommendation: Choose “Yes, Apply Settings” for immediate operational readiness.

​

6. Project Story Syncing

​

6.1 Understanding Sync Status

• 🟢 Green: Local and cloud versions are in sync
• 🟡 Yellow: Out of sync - local and cloud versions differ
• 🔴 Red: Error occurred during sync status check
• ⚪ Gray: Currently checking sync status

​

6.2 Sync Process

1. In the VRse Studio Projects window, observe the sync status indicator
2. Wait for status check to complete if indicator shows gray (⚪)

1. Click the Sync button in the VRse Studio Projects window

• “Get Story”: Downloads the latest story version from Studio to your local environment
  • Use when: Status is yellow (🟡) and you want the cloud version
  • Use when: Starting new development work
  • Use when: Collaborating with others who have made changes
  
• “Push Story”: Uploads your local story version to Studio
  • Use when: Status is yellow (🟡) and you want to upload your local changes
  • Use when: You have completed local modifications
  • Use when: You want to share your work with collaborators
  

​

6.3 Sync Best Practices

1. Always check sync status first
2. Use “Get Story” to ensure you have the latest version
3. Wait for green (🟢) status before beginning development

1. Test your changes locally
2. Use “Push Story” to upload completed work
3. Verify green (🟢) status after successful push

1. Check your network connection
2. Verify your login credentials are still valid
3. Contact support if the error persists
4. Do not attempt sync operations until error is resolved

Important: Never push local changes without first checking if cloud has been updated by others. Always resolve conflicts by communicating with your team before overwriting cloud content.

​

7. Art Scene Assignment Tool

​

7.1 Prerequisites

• You are logged into the VRseBuilder platform
• A project is selected in the Studio Project Window
• The project has RoomManagerConfig configured with experiences

​

7.2 Accessing the Tool

• Navigate to VRseBuilder → Art Scene Assignment Tool

• Opens automatically when art scenes are detected as missing

​

7.3 Interface Overview

• Current Project: Displays selected project name
• Refresh Button: Reloads project data and assignments

• Expand/Collapse All: Toggle for showing/hiding module contents
• Module Folders: Expandable sections showing experiences count

• Experience Name: Includes type badge (Training, Evaluation, etc.)
• Current Assignment: Shows currently assigned art scene
• New Assignment: Drag-and-drop target for new scenes
• Action Buttons: Apply, Clear, and Open controls

​

7.4 Assigning Art Scenes

1. Locate the module containing your target experience
2. Click to expand the module folder

1. In Unity’s Project window, locate your desired .unity scene file
2. Click and drag the scene asset to the “New:” field on the experience card

1. Click the green Apply button that appears
2. The “Current:” field will update to show the new assignment

​

7.5 Action Button Functions

• Appearance: Turns green when new assignment is pending
• Function: Saves the new art scene assignment to RoomManagerConfig
• Result: Updates the “Current:” field

• Availability: Enabled only when art scene is currently assigned
• Function: Removes existing assignment
• Result: Clears the “Current:” field

• Availability: Enabled only when valid art scene is assigned
• Function: Opens assigned art scene additively in Unity Editor
• Usage: Provides quick access for viewing or editing

​

Troubleshooting

​

Common Issues

• Verify network connectivity to VRseBuilder servers
• Confirm credentials are correct
• Check firewall settings

• Ensure sufficient disk space
• Verify Unity project permissions
• Check network stability during creation

• Confirm project selection before syncing
• Verify network connectivity
• Check for conflicting local changes

• Ensure scene files are valid Unity scenes
• Verify project structure is complete
• Check that experiences are properly configured

​

Best Practices

1. Always sync before starting work to ensure you have the latest story files
2. Save frequently during configuration to prevent data loss
3. Test assignments using the Open button before finalizing
4. Keep backups of critical art scenes and configurations
5. Use descriptive names for projects and experiences for easier management