Skip to content

Commit 284f876

Browse files
committed
Enhance add VR README for the VR directory, detailing setup, usage, and publishing instructions
1 parent f8d9fb9 commit 284f876

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
# rendered files
22
*.png
33
*.mov
4+
*.pkl
5+
*.npz
6+
*.mp4
7+
*.json
8+
*.jsonl
9+
*.npy
10+
11+
# deprecated files
12+
_old*
13+
14+
# VR directory
15+
VR/node_modules/
16+
!VR/package.json
17+
!VR/package-lock.json
418

519
# Byte-compiled / optimized / DLL files
620
__pycache__/
721
*.py[cod]
822
*$py.class
923

24+
research
25+
model
26+
logs
27+
evaluations
28+
1029
# C extensions
1130
*.so
1231
*.swp

VR/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# VR Prototype Interface
2+
3+
This folder contains the Quest WebXR client and startup scripts for the multi-user soft-arm VR prototype powered by the `virtual_field` package.
4+
Deployment model:
5+
- Linux desktop starts and hosts the VR services.
6+
- Clients join over URLs:
7+
- Headgear client opens HTTPS URL in Quest Browser.
8+
- Object-publisher client connects to WSS URL from Python CLI.
9+
10+
## Quick start
11+
12+
Use `npx` or `bunx`, depending on your preference.
13+
14+
### Serve the WebXR client over HTTPS
15+
16+
Serve the WebXR client over HTTPS:
17+
18+
```bash
19+
# In VR directory
20+
npx serve client -l 8443 --ssl-cert certs/dev-cert.pem --ssl-key certs/dev-key.pem
21+
# or
22+
bunx serve client -l 8443 --ssl-cert certs/dev-cert.pem --ssl-key certs/dev-key.pem
23+
```

0 commit comments

Comments
 (0)