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 the following command:

npm i -g pnpm

If you need to install a specific version of Node.js, you can use nvm to manage versions.

Clone the Repository

git clone https://github.com/HasangerGames/suroi-wiki.git
cd suroi-wiki

Git Submodules

The repository uses git submodules to manage dependencies. Run the following commands to initialize and update the submodules:

git submodule init
# Do not use --remote as it does not respect the selected commit
git submodule update

Install Dependencies

Install the required dependencies using pnpm:

pnpm install

Development

To start a local development server, run:

git checkout dev 
# This switches to the `dev` branch of the wiki with all the new changes
pnpm dev

Then, open https://127.0.0.1:3000 in your browser to view the wiki. You can have this open while you make changes as it will automatically update!

Production

To build the wiki for production, run:

pnpm build

To start the production server, use:

pnpm start

Quickstart

If you want to setup the wiki quickly, copy the following script and paste it into your terminal. Though it is highly recommended to go through all the steps so you understand how the wiki is running. This also assumes that you have all the packages installed.

git clone https://github.com/HasangerGames/suroi-wiki.git
cd suroi-wiki
git submodule init
git submodule update
pnpm install
pnpm dev