hathora / builder

Multiplayer game framework
https://docs.hathora.dev/#/builder/
MIT License
553 stars 35 forks source link
framework game gamedev multiplayer networking realtime websocket

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: ```sh npm install -g hathora ``` Clone an example hathora game: ```sh git clone https://github.com/hathora/ship-battle.git ``` Inside the `ship-battle` directory, start the Hathora dev server: ```sh hathora dev ``` Finally, visit http://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](https://user-images.githubusercontent.com/5400947/149647035-91442df6-73d6-4b55-ae30-f3862e8b5c8b.png) For a deeper introduction, take a look at the [tutorial](https://docs.hathora.dev/#/builder/tutorial_among_us). ## Examples Here are some other example apps built with hathora: - [avalon](examples/avalon) - [chess](examples/chess) - [codenames](examples/codenames) - [poker](examples/poker) - [rock-paper-scissor](examples/rock-paper-scissor) - [uno](examples/uno) - [tussie-missue](https://github.com/hpx7/tussie-mussie) - [hive](https://github.com/knigam/hive) ## Community Discord: https://discord.com/invite/hathora ## Contributing To contribute to Hathora, first clone the repo: ```sh https://github.com/hathora/hathora ``` Make sure you have `ts-node` installed globally: ```sh npm install -g ts-node ``` You can now invoke your local hathora cli as follows: ``` ts-node /path/to/hathora/cli.ts dev ```