Suroi

<div align="center"> <img src="client/public/img/backgrounds/github_background.png" alt="Suroi"> <hr> </div> <div align="center"> <img src="https://img.shields.io/badge/bun-%23f472b6.svg?style=for-the-badge&logo=bun&logoColor=white"> <img src="https://img.shields.io/badge/typescript-%233178C6?style=for-the-badge&logo=typescript&logoColor=white"> <img src="https://img.shields.io/badge/pixijs-%23e22162.svg?style=for-the-badge"> <img src="https://img.shields.io/badge/vite-%235468FF.svg?style=for-the-badge&logo=vite&logoColor=white"> <img src="https://img.shields.io/badge/html-%23E34F26?style=for-the-badge&logo=html5&logoColor=white"> <img src="https://img.shields.io/badge/scss-%23CC6699?style=for-the-badge&logo=sass&logoColor=white"> <br> <img src="https://img.shields.io/github/stars/HasangerGames/suroi?style=for-the-badge&logo=github"> <img src="https://img.shields.io/github/package-json/v/HasangerGames/suroi?style=for-the-badge"> <img src="https://img.shields.io/github/actions/workflow/status/HasangerGames/suroi/ci.yml?style=for-the-badge"> </div>

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 Git and Bun.

Use the following command to clone the repo:

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

Enter the newly created suroi directory with this command:

cd suroi

Finally, run this command in the suroi directory to install dependencies:

bun install

Development

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

bun dev

Or, to see output from the server and client separately, you can use the bun dev:server and bun 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 the client for production, run this command in the project root:

bun build:client

To start the game server, run this command:

bun start

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