About

Suroi is an open-source 2D battle royale game inspired by surviv.io. It is currently a work in progress.

Play the game!

suroi.io

Donate!

Any amount helps! All donation money goes towards keeping the servers running.

ko-fi.com/suroi

Join the Discord!

discord.suroi.io

Installation and setup

Start by installing Node.js and pnpm.

Next, click here to download the repo, or use the following command to clone it:

git clone https://github.com/HasangerGames/suroi.git

To install dependencies, open a terminal in the project root, and run this command:

pnpm install

This will create a node_modules directory in all three folders (client, common, and server) and link the packages there.

Development

To run the game locally, open a terminal in the project root and run the following:

pnpm dev

To open the game, go to http://127.0.0.1:3000 in your browser.

Production

To build for production, run this command in the project root:

pnpm build

To start the WebSocket server, run this command:

pnpm start

Production builds are served using NGINX. A sample configuration file can be found here.

Self-hosting

Visit the wiki for details on how to self-host.