Skip to content
Hyperfy.how

Getting Started

Creator Docs

These docs are for 3D artists and developers looking to build assets and/or fully interactive apps that are compatible with the Hyperfy world engine.

Models

When you drag and drop a GLB into a Hyperfy world you create an app entity. Additionally, you can drag a VRM into a Hyperfy world to update the mesh of your player entity.

Scripts

Follow the scripting guide to get started adding interactivty to your Hyperfy world.

Commands

Give yourself priviledges with /admin <admin-key>. Additional commands can be found in commands.md.

API Reference

Information about Hyperfy’s global API’s can be found in the reference directory.

Community Assets

Some GLTF models that are ready to drag and drop into your hyperfy world like the hyperDuck.glb can be found in the assets directory.

Hyperworld.host App Marketplace

Check out some ready made Apps to drag ‘n drop into your world! 🚀

Still intimidated? Hop in the sandbox.

Find yourself a nice Avatar.

FAQs

If you run into problems please feel free to join our Discord to ask for help, but some issues others have run into are documented in the FAQ.