From 634d226f2714a74df36658706f24840c1072a60f Mon Sep 17 00:00:00 2001 From: MayaTheShy Date: Sun, 9 Nov 2025 03:11:12 -0500 Subject: [PATCH] Implement Overte Authentication and Add Test Entities - Added documentation for Overte authentication implementation in `docs/OVERTE_AUTH.md`. - Introduced new GLB files for cube and sphere primitives in `examples/primitives/`. - Created a JSON file `examples/test_entities.json` containing sample entities for testing. - Added a build and test script `scripts/build_and_test.sh` for streamlined building and verification of the project. - Implemented a CI test runner script `scripts/ci-test.sh` to automate testing processes. - Created a script `scripts/run_with_auth.sh` to facilitate running the Starworld client with Overte authentication. --- README.md | 7 +++++-- CHANGELOG.md => docs/CHANGELOG.md | 0 CI_SETUP_SUMMARY.md => docs/CI_SETUP_SUMMARY.md | 0 CODE_CLEANUP_PLAN.md => docs/CODE_CLEANUP_PLAN.md | 0 DEVELOPER_GUIDE.md => docs/DEVELOPER_GUIDE.md | 0 .../ENTITY_RENDERING_ENHANCEMENTS.md | 0 .../MODELCACHE_IMPLEMENTATION.md | 0 .../OVERTE_ASSIGNMENT_CLIENT_TASK.md | 0 OVERTE_AUTH.md => docs/OVERTE_AUTH.md | 0 {primitives => examples/primitives}/cube.glb | Bin {primitives => examples/primitives}/sphere.glb | Bin test_entities.json => examples/test_entities.json | 0 build_and_test.sh => scripts/build_and_test.sh | 0 ci-test.sh => scripts/ci-test.sh | 0 run_with_auth.sh => scripts/run_with_auth.sh | 0 15 files changed, 5 insertions(+), 2 deletions(-) rename CHANGELOG.md => docs/CHANGELOG.md (100%) rename CI_SETUP_SUMMARY.md => docs/CI_SETUP_SUMMARY.md (100%) rename CODE_CLEANUP_PLAN.md => docs/CODE_CLEANUP_PLAN.md (100%) rename DEVELOPER_GUIDE.md => docs/DEVELOPER_GUIDE.md (100%) rename ENTITY_RENDERING_ENHANCEMENTS.md => docs/ENTITY_RENDERING_ENHANCEMENTS.md (100%) rename MODELCACHE_IMPLEMENTATION.md => docs/MODELCACHE_IMPLEMENTATION.md (100%) rename OVERTE_ASSIGNMENT_CLIENT_TASK.md => docs/OVERTE_ASSIGNMENT_CLIENT_TASK.md (100%) rename OVERTE_AUTH.md => docs/OVERTE_AUTH.md (100%) rename {primitives => examples/primitives}/cube.glb (100%) rename {primitives => examples/primitives}/sphere.glb (100%) rename test_entities.json => examples/test_entities.json (100%) rename build_and_test.sh => scripts/build_and_test.sh (100%) rename ci-test.sh => scripts/ci-test.sh (100%) rename run_with_auth.sh => scripts/run_with_auth.sh (100%) diff --git a/README.md b/README.md index 5169c7a..da75715 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Starworld is an [Overte](https://overte.org) client that renders virtual world e ### Build Everything ```bash -./build_and_test.sh +./scripts/build_and_test.sh ``` Or manually: @@ -213,7 +213,10 @@ Starworld/ │ ├── src/lib.rs │ └── Cargo.toml ├── tests/ # Test harness -└── tools/ # Python utilities +├── tools/ # Python utilities +├── scripts/ # Build and utility scripts +├── docs/ # Documentation files +└── examples/ # Example configurations and models ``` ### Debugging diff --git a/CHANGELOG.md b/docs/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to docs/CHANGELOG.md diff --git a/CI_SETUP_SUMMARY.md b/docs/CI_SETUP_SUMMARY.md similarity index 100% rename from CI_SETUP_SUMMARY.md rename to docs/CI_SETUP_SUMMARY.md diff --git a/CODE_CLEANUP_PLAN.md b/docs/CODE_CLEANUP_PLAN.md similarity index 100% rename from CODE_CLEANUP_PLAN.md rename to docs/CODE_CLEANUP_PLAN.md diff --git a/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md similarity index 100% rename from DEVELOPER_GUIDE.md rename to docs/DEVELOPER_GUIDE.md diff --git a/ENTITY_RENDERING_ENHANCEMENTS.md b/docs/ENTITY_RENDERING_ENHANCEMENTS.md similarity index 100% rename from ENTITY_RENDERING_ENHANCEMENTS.md rename to docs/ENTITY_RENDERING_ENHANCEMENTS.md diff --git a/MODELCACHE_IMPLEMENTATION.md b/docs/MODELCACHE_IMPLEMENTATION.md similarity index 100% rename from MODELCACHE_IMPLEMENTATION.md rename to docs/MODELCACHE_IMPLEMENTATION.md diff --git a/OVERTE_ASSIGNMENT_CLIENT_TASK.md b/docs/OVERTE_ASSIGNMENT_CLIENT_TASK.md similarity index 100% rename from OVERTE_ASSIGNMENT_CLIENT_TASK.md rename to docs/OVERTE_ASSIGNMENT_CLIENT_TASK.md diff --git a/OVERTE_AUTH.md b/docs/OVERTE_AUTH.md similarity index 100% rename from OVERTE_AUTH.md rename to docs/OVERTE_AUTH.md diff --git a/primitives/cube.glb b/examples/primitives/cube.glb similarity index 100% rename from primitives/cube.glb rename to examples/primitives/cube.glb diff --git a/primitives/sphere.glb b/examples/primitives/sphere.glb similarity index 100% rename from primitives/sphere.glb rename to examples/primitives/sphere.glb diff --git a/test_entities.json b/examples/test_entities.json similarity index 100% rename from test_entities.json rename to examples/test_entities.json diff --git a/build_and_test.sh b/scripts/build_and_test.sh similarity index 100% rename from build_and_test.sh rename to scripts/build_and_test.sh diff --git a/ci-test.sh b/scripts/ci-test.sh similarity index 100% rename from ci-test.sh rename to scripts/ci-test.sh diff --git a/run_with_auth.sh b/scripts/run_with_auth.sh similarity index 100% rename from run_with_auth.sh rename to scripts/run_with_auth.sh