Merge remote-tracking branch 'origin/dev'

Author: ashconnell

.prettierignore

@@ -1,2 +1,3 @@
 *.md
-Vector3Enhanced.js
+Vector3Enhanced.js
+GLTFLoader.js

CHANGELOG.md

@@ -13,6 +13,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## [v0.10.0]
+
+### Added
+- core: new streamlined user interface
+- core: grayscale overlay when disconnected
+- core: new world menu for admins to change world environment, default avatar, spawns etc
+- core: new gizmo for fine-grained builder controls
+- apps: controller support for tag, contacts and layers
+- apps: support for interleaved buffer geometry
+- apps: geometry handles
+- apps: Math globals
+- apps: player.local boolean
+- apps: ui margin and padding per side
+- apps: apps can now redirect to a url or open in a new tab 
+- apps: ability to load models from a url on the fly
+- apps: node.get(id) to find matches inside any node hierarchy
+- core: new mod/plugin hooks (experimental)
+- core: added ping time to /stats
+
+### Changed
+- apps: uiimage node stability and docs
+- apps: ui absolue positioning and flex additions
+
+### Fixed
+- apps: ui gap size not correct
+- core: vr button not working
+- core: octree issues with tiny objects, improves memory usage
+- core: fix audio unmount issues
+- core: equipping one vrm while one is already uploading (race condition)
+
 ## [v0.9.0]
 
 ### Added
@@ -289,7 +319,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Basic project structure
 - Core functionality from original project
 
-[Unreleased]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.9.0...HEAD
+[Unreleased]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.8.1...v0.9.0
 [0.8.1]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/hyperfy-xyz/hyperfy/compare/v0.7.1...v0.8.0

README.md

@@ -1,48 +1,118 @@
 # Hyperfy ⚡️
 
-## Overview
-
 <div align="center">
   <img src="overview.png" alt="Hyperfy Ecosystem" width="100%" />
+  <p>
+    <strong>Build, deploy, and experience interactive 3D virtual worlds</strong>
+  </p>
 </div>
 
-## 🧬 Features
+## What is Hyperfy?
 
-- Standalone persistent world
-- Host them on your own domain
-- Connect via Hyperfy for portable avatars
-- Realtime content creation in-world
-- Realtime coding in-world (for devs)
-- Fully interactive and interoperable app format
-- Highly extensible
+Hyperfy is an open-source framework for building interactive 3D virtual worlds. It combines a powerful physics engine, networked real-time collaboration, and a component-based application system to create immersive experiences that can be self-hosted or connected to the wider Hyperfy ecosystem.
 
-## 🦹‍♀️ Use Cases
+## 🧬 Key Features
 
-- Live events
-- Storefronts
-- Podcasts
-- Gaming
-- Social
+- **Standalone persistent worlds** - Host on your own domain
+- **Realtime content creation** - Build directly in-world
+- **Interactive app system** - Create dynamic applications with JavaScript
+- **Portable avatars** - Connect via Hyperfy for consistent identity
+- **Physics-based interactions** - Built on PhysX for realistic simulation
+- **WebXR support** - Experience worlds in VR
+- **Extensible architecture** - Highly customizable for various use cases
 
 ## 🚀 Quick Start
 
 ### Prerequisites
 
-- Node 22.11.0+ (eg via nvm)
+- Node.js 22.11.0+ (via [nvm](https://github.com/nvm-sh/nvm) or direct install)
 
-### Install
+### Installation
 
 ```bash
+# Clone the repository
 git clone https://github.com/hyperfy-xyz/hyperfy.git my-world
 cd my-world
+
+# Copy example environment settings
 cp .env.example .env
+
+# Install dependencies
 npm install
+
+# Start the development server
 npm run dev
 ```
 
-## 🌱 Alpha
+### Docker Deployment
+
+For containerized deployment, check [DOCKER.md](DOCKER.md) for detailed instructions.
+
+## 🧩 Use Cases
+
+- **Virtual Events & Conferences** - Host live gatherings with spatial audio
+- **Interactive Showrooms** - Create product displays and demos
+- **Social Spaces** - Build community hubs for collaboration
+- **Gaming Environments** - Design immersive game worlds
+- **Educational Experiences** - Develop interactive learning spaces
+- **Creative Showcases** - Display 3D art and interactive installations
+
+## 📚 Documentation & Resources
+
+- **[Community Documentation](https://hyperfy.how)** - Comprehensive guides and reference
+- **[Website](https://hyperfy.io/)** - Official Hyperfy website
+- **[Sandbox](https://play.hyperfy.xyz/)** - Try Hyperfy in your browser
+- **[Twitter/X](https://x.com/hyperfy_io)** - Latest updates and announcements
+
+## 📏 Project Structure
+
+```
+docs/              - Documentation and references
+src/
+  client/          - Client-side code and components
+  core/            - Core systems (physics, networking, entities)
+  server/          - Server implementation
+CHANGELOG.md       - Version history and changes
+```
+
+## 🛠️ Development
+
+### Key Commands
+
+```bash
+# Development mode
+npm run dev
+
+# Production build
+npm run build
+npm start
+
+# Clean orphaned assets (experimental)
+npm run world:clean
+
+# Viewer only (development)
+npm run viewer:dev
+
+# Client only (development)
+npm run client:dev
+
+# Linting
+npm run lint
+npm run lint:fix
+```
+
+## 🖊️ Contributing
+
+Contributions are welcome! Please check out our [contributing guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md) before getting started.
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b feature/amazing-feature`
+3. Commit your changes: `git commit -m 'Add amazing feature'`
+4. Push to the branch: `git push origin feature/amazing-feature`
+5. Open a pull request
+
+## 🌱 Project Status
 
 This project is still in alpha as we transition all of our [reference platform](https://github.com/hyperfy-xyz/hyperfy-ref) code into fully self hostable worlds.
 Most features are already here in this repo but still need to be connected up to work with self hosting in mind.
 Note that APIs are highly likely to change during this time.
-

docs/ref/Player.md

@@ -12,6 +12,14 @@ The players unique ID. This is always the same for the same player, even when th
 
 The players name.
 
+### `.local`: Boolean
+
+Whether the player is local to this client.
+
+### `.admin`: Boolean
+
+Whether the player is an admin in this world.
+
 ### `.position`: Vector3
 
 The players position in the world.

docs/ref/Props.md

@@ -89,37 +89,33 @@ A range slider input
 }
 ```
 
-### Switch
+### Toggle
 
-A switch input
+A boolean toggle field
 
 ```jsx
 {
-  type: 'switch',
+  type: 'toggle',
   key: String,           // the key on `props` to set this value
   label: String,         // the label for the text input
-  options: [
-    {
-      label: String,     // the label to show on this switch item
-      value: String,     // the value to set on the props when selected
-    }
-  ],
+  trueLabel: String,     // optional, defaults to "Yes"
+  falseLabel: String,    // optional, defaults to "No"
   initial: String,       // the initial value to set if not configured
 }
 ```
 
-### Dropdown
+### Switch
 
-A dropdown menu
+A switch field with many options
 
 ```jsx
 {
-  type: 'dropdown',
+  type: 'switch',
   key: String,           // the key on `props` to set this value
   label: String,         // the label for the text input
   options: [
     {
-      label: String,     // the label to show on this item
+      label: String,     // the label to show on this switch item
       value: String,     // the value to set on the props when selected
     }
   ],
@@ -159,29 +155,15 @@ const audio = app.create('audio', {
 audio.play()
 ```
 
-### Section
-
-A simple section header to help group fields together
-
-```jsx
-{
-  type: 'section',
-  key: String,           // a unique `key` to represent this section
-  label: String,         // the label for the section header
-}
-```
-
-### Buttons
+### Button
 
-Displays one or more buttons that when clicked, execute something in the running app.
+Displays a button that when clicked, executes something in the running app.
 
 ```jsx
 {
-  type: 'buttons',
+  type: 'button',
   key: String,           // a unique `key` for this button
   label: String,         // the label for the button
-  buttons: [
-    ...{ label: String, onClick: Function },
-  ]
+  onClick: Function,
 }
 ```

docs/ref/UI.md

@@ -57,7 +57,7 @@ Whether the canvas is doublesided. Defaults to `false`.
 
 ### `.billboard`: String
 
-Makes the UI face the camera. Can be `null`, `full` or `y-axis`. Default to `null`.
+Makes the UI face the camera. Can be `none`, `full` or `y`. Default to `none`.
 
 ### `.pivot`: String