Cellworld VR

Overview

Cellworld VR is a multi-agent research environment integrating a dedicated server with Meta Quest 3 clients, built using Unreal Engine 5.3.

---

Glossary

• System Compatibility
• Cellworld Server
• Setup
  • Cloning This Repository
  • Install Git LFS
  • Clone the Repository
  • Verify LFS Setup
• Other (Temporary)

---

System Compatibility

• Server OS: Windows 11 (Dedicated Host)
• Client Device: Meta Quest 3
• Engine: Unreal Engine 5.3.2 (Oculus-VR branch) (Engine Source)

---

Cellworld Server

Make sure to use the CellworldServer-dev branch when working with the server backend.

---

Setup

Cloning This Repository (Git LFS Required)

This repository uses Git Large File Storage (LFS) to manage large assets such as 3D models and textures.

Step 1: Install Git LFS (Windows Only)

winget install --id Git.Git -e --source winget
git lfs install

Step 2: Clone the Repository

Make sure to run the following commands to properly clone and pull large files:

git clone https://github.com/cellworld/cellworld_vr.git
cd cellworld_vr
git lfs pull

If you've already cloned the repo without Git LFS installed:

git lfs install
git lfs pull

Verify LFS Setup

To confirm that Git LFS is tracking files correctly:

git lfs ls-files

---

Other (Temporary)

Changing IP

1. ExperimentClient.h under FServerInfo(), specify "IP(TEXT("---insert--IP---"))"
2. In the UE editor, in the level blueprint "L_Game"
3. Python server pass the flag --ip<<insert_IP>>

This section can be used to include temporary notes, future plans, or development todos.