HasangerGames / suroi-wiki

The official wiki for Suroi, an open-source 2D battle royale game inspired by surviv.io.

Suroi Wiki

The official wiki for Suroi, an open-source 2D battle royale game inspired by surviv.io.

wiki.suroi.io

Setup

Node.js 20+ and pnpm are required.

If you don't have pnpm installed, you can install it with npm i -g pnpm.

git clone https://github.com/HasangerGames/suroi-wiki.git
cd suroi-wiki
git submodule init
# Do not use --remote as it does not respect the selected commit
git submodule update
pnpm install

Development

To start a local development server, run pnpm dev, then go to https://127.0.0.1:3000 in your browser (A different port maybe be used if 3000 is being used).

Production

To build for production, run pnpm build. To start the server, run pnpm start.