Skip to content

kosmotive/cs2pb

Repository files navigation

CS2PB

Run test-suite Check settings Coverage

Features

  • Squad overview web page
  • Match history web page
  • Discord integration
  • Player of the Week challenge
  • Match-wise badges (quad-kill, ace, carrier, peach, surpass yourself)
  • Session-wise badges (rising star)
  • Interactive data exploration via included JupyterLite instance and Python

Installation

Create a virtual environment for Python:

python -m venv env

Activate the environment:

source env/bin/activate

Install the dependencies:

pip install -r requirements.txt

Bootstrapping

To bootstrap CS2PB easily, there is a fully automated process:

sh bootstrap.sh

Note that this requires access to the private repository kosmotive/cs2pb-bootstrap, which you might not have access to. If you don't have access to that repository, you will have to bootstrap manually. To do that, create the file django/discordbot/settings.json (see django/discordbot/settings.json.skeleton for an example), and setup the following environment variables.

Environment variables

The following environment variables are required:

  • CS2PB_ADMIN_MAIL_ADDRESS: The mail address to send notifications to, when important failures occur which might require manual intervention (e.g., failure of the Steam API, or parsing demo files).

  • CS2PB_STEAM_API_KEY: A valid key for accessing the Steam API.

  • CS2PB_DISCORD_ENABLED: Set to 1 to enable the Discord integration.

  • CS2PB_STEAM_USERNAME: The username of the Steam account to use.

  • CS2PB_STEAM_PASSWORD: The password of the Steam account to use.

Manual bootstrapping

After setting up the environment variables, run:

cd django
python manage.py migrate
python initialize.py --help

Web links