Skip to content

hathora/builder

Repository files navigation

hathora logo

npm version node compatibility build status discord chat


Hathora Builder - multiplayer game framework

Overview

The Hathora Builder is a framework for building multiplayer games and other realtime applications.

Documentation

Visit https://docs.hathora.dev/#/builder/

Quick start

First, make sure you have node v16.12.0+ installed.

Then install the hathora cli from the npm registry:

npm install -g hathora

Clone an example hathora game:

git clone https://github.com/hathora/ship-battle.git

Inside the ship-battle directory, start the Hathora dev server:

hathora dev

Finally, visit https://localhost:3001 to see the game in action (add multiple users by opening the same url in different tabs):

Instructions: Arrow keys to move, space bar to fire.

image

For a deeper introduction, take a look at the tutorial.

Examples

Here are some other example apps built with hathora:

Community

Discord: https://discord.com/invite/hathora

Contributing

To contribute to Hathora, first clone the repo:

https://github.com/hathora/hathora

Make sure you have ts-node installed globally:

npm install -g ts-node

You can now invoke your local hathora cli as follows:

ts-node /path/to/hathora/cli.ts dev