Quick Start Installation

Prerequisites

Node 22.11.0+ (eg via nvm)

nvm install 22.11.0
nvm use 22.11.0

git clone https://github.com/hyperfy-xyz/hyperfy.git my-world
cd my-world
cp .env.example .env
npm install
npm run dev

Hyperfy v2 Repo

To work from the dev branch:

cd my-world
git fetch origin
git checkout -t origin/dev
git pull

For all things APIs, head over to Getting Started.

Add a Hyperduck to your world.

Drag ‘n drop a ready-made app into your world.

When you’re ready to host, choose between Self-hosting or a Hosting Provider.

AI can be your friend, and the community is here to help.

Still intimidated? Hop in the sandbox.

Find yourself a nice Avatar.