Skip to content

About

Run across candy-coloured clouds, jump the sleepy jellies and grab the stars. Get on the top 10. Play it at orbworlds.com/orbworlds/star-runner

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Star Runner

Star Runner

An endless runner over the clouds. Switch lanes, jump the jellies and collect stars, and when you finally bonk into something your score goes on the shared top 10.

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

Star Runner

Controls

Left and right (or A and D) switch lanes, Space or a tap jumps and starts a run. M mutes.

Run it yourself

git clone https://github.com/orbworlds/star-runner
cd star-runner
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, 489 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.store for things everyone shares, like scores
  • plain localStorage for progress, which Orb saves per player and brings along to their other devices

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

Run across candy-coloured clouds, jump the sleepy jellies and grab the stars. Get on the top 10. Play it at orbworlds.com/orbworlds/star-runner

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages