Skip to content
orbworldsPublic

About

A small plaza where you see everyone who has it open right now. Walk around and say hi. Play it at orbworlds.com/orbworlds/hangout

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Hangout

Hangout

About as simple as a multiplayer world gets: a glowing plaza where everyone who has it open shows up as a character. Walk around, wave, send a reaction. It's a good place to start if you want to see how rooms and presence work on Orb.

Play it on Orb. It runs in the browser on a computer, phone or tablet, and you don't need an account.

Hangout

Controls

WASD or tap the ground to move. The buttons at the bottom say hi or send a reaction.

Run it yourself

git clone https://github.com/orbworlds/hangout
cd hangout
npm install
npm start

That opens it at http://127.0.0.1:4242 with the Orb kit, which npm install brings and which gives the game what it gets on Orb: other players (open a second tab, or press + Player), saves and shared state. You need Node 20 or newer.

The whole thing is index.html, 315 lines of HTML, CSS and JavaScript with three.js from a CDN. Edit it and the page reloads.

What it uses from Orb's world SDK (window.orb, typed in @orbworlds/kit/orb.d.ts):

  • orb.room for multiplayer (who is here, what they are doing, messages between players)

Outside Orb and the kit, window.orb isn't there and the game carries on without it.

Make your own version

You can remix it on Orb without touching code: open it there, choose Make my own copy and describe what you'd change. Orb's AI makes the changes in your copy.

Or fork this repository, make your changes and push them. npm run share then prints a link that brings your fork into Orb as a world of your own, credited as a remix of this one, and it stays in sync with your fork from then on.

Contributing

Pull requests are welcome. GitHub checks each one by running the world in a headless browser, which has to go without errors, and once a change is merged it's live on Orb within about 15 minutes. CONTRIBUTING.md has the details.

License

MIT, see LICENSE. The Orb name and logo aren't covered by the license.

About

A small plaza where you see everyone who has it open right now. Walk around and say hi. Play it at orbworlds.com/orbworlds/hangout

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages