Suroi
About this project
Donate!
Any amount helps! All donation money goes towards the game directly.
Join the Discord!
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.
Technologies & License
Quick Deploy
Deploy this project to cloud platforms with one click