Awesome
<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/node.js%20-%23339933.svg?style=for-the-badge&logo=nodedotjs&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%20-%23e22162.svg?style=for-the-badge"> <img src="https://img.shields.io/badge/uwebsockets.js%20-%23000000.svg?style=for-the-badge"> <img src="https://img.shields.io/badge/html-%23E34F26?style=for-the-badge&logo=html5&logoColor=white"> <img src="https://img.shields.io/badge/css-%231572B6?style=for-the-badge&logo=css3"> <img src="https://img.shields.io/badge/sass-%23CC6699?style=for-the-badge&logo=sass&logoColor=white"> <img src="https://img.shields.io/badge/vite-%235468FF.svg?style=for-the-badge&logo=vite&logoColor=white"> </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!
Donate!
Any amount helps! All donation money goes towards keeping the servers running.
Join the Discord!
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.