---

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 the game directly.

ko-fi.com/suroi

Join the Discord!

discord.suroi.io

Installation and setup

Start by installing Node.js. If you're running macOS or Linux, nvm is recommended for ease of installation.

Once Node is installed, pnpm can be installed using the following command:

npm i -g pnpm

Alternatively, pnpm can be installed from the official website.

Next, install Git, and use the following command to clone the repo:

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

You can also click here to download the repo and extract the files.

If you used Git, enter the newly created suroi directory with this command:

cd suroi

Finally, run this command in the project root to install dependencies:

pnpm install

Development

To start the game locally, run the following command in the project root:

pnpm dev

Or, to see output from the server and client separately, you can use the pnpm dev:server and pnpm dev:client commands. (Both must be running simultaneously for the game to work.)

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

The server and client can be built separately using the pnpm build:server and pnpm build:client commands.

To start the game server, run this command:

pnpm start

Production builds are served using NGINX. Visit the wiki for details on how to self-host.