Getting Started

Getting Started

This page is for contributors setting up Blockiverse VR locally.

Requirements

• macOS with Unity Hub.
• Unity Editor 6000.3.16f1 with Android Build Support, Android SDK/NDK Tools, and OpenJDK installed through Unity Hub.
• A Unity Personal or higher license accepted in Unity Hub before running batchmode commands.
• Git with LFS available for normal asset checkout work.
• Meta Quest 3 or Meta Quest 3S for hardware validation.
• hzdb for Quest device workflows when headset validation is needed.

Clone

git clone https://github.com/eslutz/Blockiverse-VR.git
cd Blockiverse-VR

If Unity is not installed at the default path, set UNITY_EDITOR:

export UNITY_EDITOR="/Applications/Unity/Hub/Editor/6000.3.16f1/Unity.app/Contents/MacOS/Unity"

First Checks

Run the repository checks:

bash -n scripts/ci/forbidden-files.sh scripts/unity/*.sh
scripts/ci/forbidden-files.sh
test -f docs/architecture/branching-and-release.md

Run local Unity validation before moving Unity-impacting work to review:

scripts/unity/run-tests.sh
scripts/unity/build-development-apk.sh /tmp/blockiverse-vr-development.apk

The test script writes NUnit XML results to:

• TestResults/Unity/EditMode.xml
• TestResults/Unity/PlayMode.xml

Quest Device Work

Use hzdb for Quest device workflows:

hzdb --version
hzdb device list

Use hzdb for install, launch, log capture, screenshots, recordings, file transfer, and performance captures when the command supports the task. Use adb only when hzdb does not expose the needed operation, and document why.

Local Generated Artifacts

Do not commit Unity Library, Temp, Logs, local screenshots, recordings, Perfetto traces, APKs, keystores, signing credentials, .env files, or local device logs unless a tracked artifact is explicitly required.

Useful Source Links

• Testing and Verification
• Architecture
• docs/roadmap/blockiverse_vr_execution_plan.md
• docs/rulesets/