Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.64 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.64 KB
Raw

UncivServer.xyz

An open source, free-to-play, Unciv multiplayer server written in TypeScript.

To run locally

To run UncivServer.xyz locally, you would need:

  1. Git: If you are on Linux then Git should be installed by default. On Windows, install from here.
  2. Bun: Install from https://bun.sh/
  3. MongoDB: You can run a local MongoDB instance with docker run -d --name some-mongo -e MONGO_INITDB_DATABASE=unciv -p 27017:27017 mongo. Alternatively, you can make a free MongoDB instance with the database name unciv from here.

All of your data would be hosted at your MongoDB server. Now clone this project and open the directory and make a file named .env.

git clone https://github.com/touhidurrr/UncivServer.xyz.git
cd UncivServer.xyz

# If running via docker, should be `echo "MONGO_URL=mongodb://localhost" > .env`
echo "MONGO_URL=<Your MongoDB URL>" > .env

# Required for sync tests to pass
echo "SYNC_TOKEN=$(openssl rand -base64 32)" >> .env

Now run the following commands to start your server! By default, the server will start at http://0.0.0.0:1557, which you can access from http://localhost:1557 from your browser. However, you can change this behavior setting PORT and HOST environment variables in the .env file you just made. Note that both of these variables are optional.

bun install --frozen-lockfile
bun start

Development

To start the development server run:

bun dev

Don't forget to lint, format, and test the code before submitting a pull request.

bun lint
bun format
bun test