Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.61 KB

README.md

File metadata and controls

88 lines (62 loc) · 2.61 KB

The tf2pickup.org server

Latest release Test status Code coverage MIT license Wekan

Documentation »

About the project

tf2pickup.org was created with a simple objective in mind. Make it as easy and accessible for twelve players to play a 6v6 pick-up game in Team Fortress 2 as possible.

Local deployment

Setup

  • Clone the repository or download a zipped release of your choice

  • Open the terminal inside the repository folder

  • Install the dependencies

    $ pnpm install
  • Copy and rename sample.env to .env and adjust your environment values, mainly:

    • STEAM_API_KEY - your Steam API key, the "Domain Name" can be set to anything you like,
    • LOGS_TF_API_KEY - your logs.tf API key,
    • SUPER_USER - your SteamID64,
    • LOG_RELAY_ADDRESS - your IP address in the local network.

Deployment

  • Start the required services

    $ docker-compose up -d
  • Finally, run the server in development mode

    $ pnpm dev

    By default, the server is listening on port 3000 .

Docker images

$ docker pull ghcr.io/tf2pickup-org/server:stable

Supported tags

Contact