Quick Start Installation

This will setup a world locally on your machine that you can then self-host.

You can start a hosted world from a hosting provider without needing to setup locally, if you prefer.

Hyperfy v2 Repo

🌟Star the Repo🌟

Prerequisites

(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

Each separated below for easy copying.

git clone https://github.com/hyperfy-xyz/hyperfy.git my-world

cd my-world

cp .env.example .env

npm install

npm run dev

After above, your world is now running in http://localhost:3000/. Open in browser.

Success

When your world is not running (you kill the terminal) you can change the my-world to anyname you want for your world.

Just remember next time, you will cd 'new world name' then npm run dev

For a full guide on forking and branch management check out Cheddar’s Forking Guide

To work from the dev branch you do everything above to clone and install the repo and then:

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

Each separated below for easy copying.

cd my-world

git fetch origin

git checkout -t origin/dev

git pull

npm run dev

When you’re ready to host, choose between:

If you run into please feel free to join Hyperfy Discord to ask for help. The community is knowledgeable and very supportive.