How jerometremblay/hyperfy works
Hyperfy is a browser-based multiplayer 3D world platform, with this fork adding construction tools, splats, browser surfaces, pose editing, and enhanced XR avatars. The main workflow is a player entering a world, where the client renders and synchronizes a shared scene; users can build or edit objects and interact with other players. Server-side world networking and persistence support that experience. The README documents the fork’s feature branches, while source excerpts expose world setup and selected builder, app, and server behavior; relationships for unsampled systems are omitted unless documented.
Main entry points: createClientWorld.js Client world setup · index.js Server entry · world-client.js Client entry · App.js App runtime
Components 30
World runtime
- Client entry
src/client/world-client.js - World simulation
src/core/World.js - System lifecycle
src/core/systems/System.js - Client world setup
src/core/createClientWorld.js - Client networking
src/core/systems/ClientNetwork.js - Scene nodes
src/core/nodes/Node.js - App runtime
src/core/entities/App.js - 3D utilities
src/core/extras/three.js - Control priorities
src/core/extras/ControlPriorities.js - Scene layers
src/core/extras/Layers.js - App tools
src/core/extras/appTools.js - Runtime lockdown
src/core/lockdown.js - Client actions
src/core/systems/ClientActions.js
Building and editing
- Core world UI
src/client/components/Sidebar.js - World builder
src/core/systems/ClientBuilder.js - Prompt-box workflow
src/core/extras/PromptBoxWorkflow.js
Avatars and interaction
- Sitting-pose editor
src/core/systems/ClientPoseEditor.js - Controls and hand tracking
src/core/systems/ClientControls.js - Player nametags
src/core/systems/Nametags.js
Server services
- Server entry
src/server/index.js - Server world setup
src/core/createServerWorld.js - World database
src/server/db.js - Server storage
src/server/Storage.js - Server asset loader
src/core/systems/ServerLoader.js
Fork capabilities
- Gaussian splat node
src/core/nodes/GaussianSplat.js - Browser surfaces
src/core/nodes/Browser.js - Private webview
src/core/nodes/WebView.js - Extruded primitives
src/core/nodes/Prim.js - XR tracking
src/core/systems/XR.js
Other components
- World player
Connections 30
- World player → Client entry: enters world
src/client/world-client.js - Client entry → Client world setup: creates
src/client/world-client.js - Client world setup → World simulation: instantiates
src/core/createClientWorld.js - Client world setup → Client networking: registers
src/core/createClientWorld.js - World simulation → System lifecycle: runs lifecycle
src/core/World.js - World simulation → App runtime: registers
src/core/World.js - App runtime → Scene nodes: creates nodes
src/core/entities/App.js - Client world setup → World builder: registers
src/core/createClientWorld.js - Client world setup → Sitting-pose editor: registers
src/core/createClientWorld.js - Client world setup → Controls and hand tracking: registers
src/core/createClientWorld.js - Client world setup → Player nametags: registers
src/core/createClientWorld.js - Client entry → Core world UI: renders
src/client/world-client.js - World builder → Prompt-box workflow: uses workflow
src/core/systems/ClientBuilder.js - World player → World builder: edits world
README.md - World player → Sitting-pose editor: adjusts seat pose
README.md - Controls and hand tracking → XR tracking: tracks hands
README.md - Server entry → Server world setup: creates
src/server/index.js - Server entry → World database: initializes
src/server/index.js - Server entry → Server storage: initializes
src/server/index.js - World player → Gaussian splat node: loads and transforms
README.md - World player → Browser surfaces: shares browser input
README.md - World player → Private webview: uses private browser
README.md - World player → Extruded primitives: builds primitives
README.md - System lifecycle → 3D utilities: uses 3D runtime
- App runtime → Scene layers: uses layer rules
src/core/entities/App.js - App runtime → Control priorities: uses priorities
src/core/entities/App.js - World database → App tools: uses app tools
src/server/db.js - Server entry → Server asset loader: configures world
- Client entry → Runtime lockdown: imports runtime guard
src/client/world-client.js - Client world setup → Client actions: registers
src/core/createClientWorld.js