Join us on discord if you use it, for feedback, troubleshooting and information about updates and general Hell Let Loose hosting info: https://discord.gg/hZx6gn3

Hell Let Loose (HLL) Community RCON (CRCON)

An extended RCON tool for Hell Let Loose, meant to replace the official tool and go WAY beyond.

Included features

Manage your games and players in realtime

• See all the players currently in game (live view with game logs or game view with players by squad/team):

  • Unique player IDs (steam 64 ID or Windows Store ID)
  • Steam profile (with API key configured) for steam players (country, bans, etc.)
  • VIP status
  • Current session (connection time, play time) and session history (total play time, number of sessions, etc.)
  • Current level, team, squad, role and loadout
  • Current combat/attack/defense/support scores
  • Current kills and deaths numbers and miscellanous other statistics like kills per minute

• Individual player actions or grouped (multiple players at the same time)

  • message the player in game
  • team switch the player immediately or when the player dies
  • punish (kill in game), kick, temp ban (you choose the duration) or perma ban with a message
  • watch players to receive a Discord notification (ping) when they connect
  • flag players (helps to find some users quickly in the player history
    or activate options used by moderation bots)

• Recording of you map history, you see which map were played and how long they lasted

• Maintain individual (by CRCON account) or shared message templates for punishments, etc.

• A live view that shows you all currently connected players and all of the game server logs, as well as filter them by action or player:

  • Player connections/disconnections
  • Kills, team kills
  • Messages sent to players from CRCON
  • Team/unit chat
  • Automatic game server actions (idle kick, high ping kick, etc.)
  • Admin actions (kick, temp bans, etc.)

Admin Accounts / Audit Trail

• Individual accounts per admin so you never need to share your game server RCON password
• Fine grained permissions that allow you to restrict exactly what an admin can do
  • Can be used to create read only accounts (for instance if you run events and want to allow streamers/etc. to view the kill feed)
  • Can create a tiered admin system (for instance if you want to allow people monitoring seeding to only be able to kick players but not ban them)
• Audit logs showing which accounts performed which actions for accountability
• Optional Discord integration to send audit actions to a webhook

API / API Keys

• An ever growing number of API endpoints to allow you to write tools without having to fully implement the RCON protocol yourself
• Ability to generate/authenticate with API keys for easier tool access

Manage your players database

• History of all players who have connected

  • All names they've played with
  • All messages they have received in game (some automated messages are not saved)
  • Their sessions (connect/disconnect times, play time, etc.)
  • Punishments (kicks, bans, etc.)

• Filter by player name, player ID (steam/windows store IDs), etc.

• Apply actions to players even if they are not online anymore

• Ban (blacklist) people, even if those who have never played on your server.

• Permanent logs : search through the entire history of the game logs of your server, export logs as CSV.

• Bans, blacklist and VIP backup/restore

Automatic server settings (Auto Settings)

• Settings that can be applied based on different conditions (time of day, number of connected players, current map, number of connected admins, etc.)
• Change most (but not all) game server/CRCON settings, including but not limited to:
• broadcast and welcome messages
• game server settings (teamswitch cooldown, autobalance threshold, idle autokick, maximum ping, max queue length, VIP slots, vote kicks, profanities in chat).
• maps rotation or map vote
• Map rotations (late night or seeding rotations, etc.)
• Map shuffle

Automatic Moderation

Auto Mods

• Automatic enforcement of various rules (within RCON limitations) with the ability to warn (message the player), punish and/or kick in a progressive fashion based on number of warnings/time between warnings
• Level Enforcement
  • Remove players from the server who are above or below level limits
  • Forbid players from playing roles (Commander, Tank Commander, Squad Leader, etc.) who are above or below level limits
• Squad Leader Enforcement
  • Forbid squads without squad leads
• Seeding Enforcement
  • Ban weapons
  • Ban roles
  • Prevent (very limited due to RCON limitations) attacking objectives (for example, only allow the middle point to be contested)
• No Solo Tank Enforcement
  • Forbid players from being in a tank squad without other players (can't determine if the squad is locked due to RCON limitations)

Miscellaneous automatic enforcement of rules

• Set regular expressions to remove players based on their name, for example:
  • Remove players with only numbers in their name
  • Remove players without at least one character (A-Z or a-z) to avoid all symbol names
  • Player names that contain words (ie : "nazi", "fucker", etc.)
  • Any regular expression you can craft should work!
• Remove players with names that will not work properly with RCON commands because of RCON bugs:
  • Player names that end in white space (or end in white space after the game trims the name to RCONs 20 byte maximum)
  • Player names that (due to an RCON bug) have multi byte unicode code points that the game server chops off (pineapple names)
• Remove game pass players on connect (if your GSP hasn't exposed the file to turn it off at the server level)
• Automatically perma ban players who only team kill after connecting
• Automatically perma ban steam players with X number of VAC and/or game bans within Y days (with a Steam API key configured)

Chat Commands

• Ability to create your own custom commands that players can trigger with chat messages
• A limited (but growing) number of variables can be used in the message
• For example you can create commands to
• Chat commands : user defined trigger words that will send user-defined messages.
  ie : !Discord to display your Discord clan url,
  !killer to display the name of your last killer

Discord Integration

• Create Discord webhooks to send information from CRCON to your Discord server
  • Kills/Team kills
  • Player chat
  • Admin cam usage
  • Various automated actions (auto mods, etc.)
  • Admin actions (audit trail)
  • Live scoreboard (current map, time remaining, number of players connected, top kills, etc.) that updates in real time
• Admin pings that will notify (ping) user or roles when certain words are used (!admin, etc.)
• Ability to send any log action (map start, admin kick, etc.) with optional user/role notifications

Public stats webpage

• Live game
• Historical games (bookmarkable)

Power users features

• Supports multiple game servers within a single CRCON install
  • CRCON admin accounts/permissions are shared (and can't be limited by game server)
  • Shared player history
  • Shared blacklist (permanent bans stored in CRCON)
  • Apply actions (except permanent bans due to the blacklist) on a server by server basis, or forward actions to the other servers to keep them in sync
• Create your own plugins and manage them from the Services section of the settings page

Some images

Manage your games and players in realtime

Manage your players database

Automatic server settings

Permanent logs

Features to come (maybe)

• Leaderboard and all time stats

Installation

Minimum Skills

You only need very limited shell skills, you can mostly just follow along with the instructions but you need to understand what a directory is, how to list the contents of a directory, change directories, etc.

Install on a VPS, not on your home PC

CRCON is a website and is designed to run permanently (24/7) and be accessible on the Internet since your players (public stats) and admin accounts will connect to it.

This allows you to maintain a separation between admin accounts and the game server and provides a centralized database for both game server data (logs, etc.) and admin actions

• You do not need to share the game server RCON password (and should avoid doing so unless you have a good reason or people can skip audit logs)
• Admin actions are recorded/logged

Because of this, it is much easier to rent a cheap VPS and run it there than to try to install it on a home computer, ensure that connections are forwarded properly and that it is always on/available.

Your users also don't need to install any software, they simply log into the website.

If you decide to install it on a home computer, keep in mind you'll have to :

• run your computer 24/7
  hope you like noisy fans, hardware maintenance and electricity bills ;
• open your home internet access and let people connect to your computer.
  This requires network management knowledge and could lead to security risks.

Hardware requirements

• Minimum : 2 CPU cores and 6GB of RAM.
• Recommended : 4 CPU cores and 8GB of RAM.
• Regarding drive space, the CRCON database of a game server where 95+ players connect for 10 hours per day may grow up to 20 GB in a year.
  As it's not easy to shrink it, you are advised to select an offer with >50 GB of storage.

You can run on as little as 3.something gb of RAM but as it's not necessarily easy to increase the amount of RAM your VPS has, it's better to pad it a little bit. The more game servers you use within a CRCON install the more RAM/CPU/storage you'll utilize.

Some VPS providers rent this type of services for ~$5-10/month.

Software requirements

In theory you can run this anywhere you can use Docker and Docker Compose, but unless you have a really good reason you should use Linux (any distro should work, but if you're unfamiliar you want to pick a more popular one like Ubuntu or Debian for easier tech support when you Google) instead of Windows or any other operating system.

If you use any CPU architecture other than amd64 you won't be able to use the hosted Docker images and will have to build your own.

If you run it on Windows, don't expect anyone to be able to help you on the Discord.

• (Optional but highly recommanded) git : https://git-scm.com/downloads
  (if you don't use git, you'll have to manually download and install the releases in .zip format,
  and you won't be able to update your CRCON as easily as with git)
• Docker Engine (Community) : https://docs.docker.com/engine/install/
  You can also use Docker Desktop, but you may have issues with nested virtualization, depending on your computer/server/VPS.
• Docker Compose : https://docs.docker.com/compose/install/
  Note : docker-compose is deprecated.
  This README and release announcements will show docker compose examples.
  You should still be able to use docker-compose and will have to adjust the commands below accordingly. but you should really just use the modern version and avoid potential issues. We can't/won't guarantee that future releases will work properly with docker-compose

Some VPS providers offer free installation of linux distributions in which Docker is already activated. Search/ask for it !

Install steps

"I don't know anything about console commands, coding and such ?"

• Stay cool and follow the drill. It's a simple installation, many not-so-technical people managed to do it, so you probably can too :)
• There's also a Wiki made by the community (Thanks [2.Fjg]bn.hall): https://github.com/MarechJ/hll_rcon_tool/wiki
  (The Wiki is obsolete. We hope we'll find the time to update it soon)
• Most shell commands/error messages can be Googled, and a lot of usual questions already found an answer on the CRCON's Discord. Ask for help on the tech-support channel if you can't find what you're searching for.
• If you still don't understand what to do after reading this, just ask on Discord, but please respect peoples time and energy and at least attempt to solve your problem by using Google/other resources first.

Note : all the commands given below are meant to be entered in a Debian-like Linux terminal.

1. Download CRCON

Using an SSH client (don't know which one to get ? Try PuTTY : https://www.chiark.greenend.org.uk/~sgtatham/putty/),
log in as root into your distant Linux, using the SSH credentials given by your VPS provider.

Enter these commands in the terminal (press [Enter] to validate) :

• download the CRCON files :

  git clone https://github.com/MarechJ/hll_rcon_tool.git

• get in the newly created CRCON dedicated folder :

  cd hll_rcon_tool

2. Edit the environment config file

Now, you're going to create and edit an .env file, in which you'll tell CRCON how to connect to your HLL game server.
Here we'll use nano, a simple text editor that runs in text mode.
You can use any other tool you're used to, either local or getting the file from a SFTP connection.

• make a copy of the environnement config file template :

  cp default.env .env

• install the nano text editor :

  apt-get update && apt-get install nano

• launch nano to edit the .env file :

  nano .env

In nano, you can move the cursor with the arrow keys.
You do not have to change all the values. Only these 5 are mandatory :

1. Choose a password to give CRCON access to the database
   (No need to remember/note it : you'll never have to enter it anywhere), check the comments in the .env for restriction characters such as %.
   Do NOT change it after CRCON has been started at least one time : your database would not be accessible.

    HLL_DB_PASSWORD=anythingwithoutanyspace
   

2. Enter a long string that will be used to scramble users passwords, you may want to back this up separately, if you lose it all of your admin accounts will be invalidated and need their passwords reset. Do NOT change it after CRCON has been started at least one time : existing passwords would be invalidated.

   RCONWEB_API_SECRET=anythingwithoutanyspaceordollarsign
   

Configure each game server you want to setup (server 1, server 2, etc. repeating the steps below for the 2nd/3rd server as necessary)

3. Enter your RCON IP, as provided by the game server provider :
   (this is NOT the same as the game server IP)

   HLL_HOST=123.123.123.123
   

4. Enter your RCON port, as provided by the game server provider :
   (this is NOT the same as the game server port)

   HLL_PORT=12345
   

5. Enter your RCON password, as provided by the game server provider :

   HLL_PASSWORD=yourrconpassword
   

Triple-check there is no space before/after the = signs, nor in the values you've set.

• save the changes with Ctrl+o (then type 'y' to validate)
• exit nano with Ctrl+x

3. Run CRCON for the first time !

CRCON is now configured to start and connect to your HLL game server.
But do not think it's over yet, as we now have to configure its users.

Note : Launch process will display a lot of scrolling text.
Don't panic, as you do not have to read/do anything. Just watch the magic.

Enter the command(s) that suit(s) your operating system :

• Linux on x86 :

  docker compose up -d --remove-orphans

• Windows on x86 :

  docker volume create redis_data
docker volume create postgres_data
docker compose -f docker-compose.yml -f docker-compose.windows.yml up -d

• Raspberry-Pi (32 bits) or any ARM32v7 :

  docker compose -f docker-compose.yml -f docker-compose.arm32v7.yml up -d --build

• Raspberry-Pi (64 bits) or any ARM64v8 :

  docker compose -f docker-compose.yml -f docker-compose.arm64v8.yml up -d --build

If eveything went well, you'll end up with some green lines saying "started" after a minute or two.
Note some lines will show errors if you do not have set values for 2nd (xxx _2 -1) or 3rd (xxx _3 -1) game server. This is normal.

If some of the final lines regarding game server 1 (xxx _1 -1) show (red) errors :
check the values you've entered in the .env file and try to start CRCON again.

Then enter the start command line(s) above again.

4. Get in the CRCON UI

Your CRCON user interface can be reached from all over the world,
in any web browser.

Each game server is accessed separately, pay attention to the RCONWEB_PORT values in your .env for each game server

For example by default you could reach game server 1 with: http://yourVPSIP:8010/ substituting the IP address of your VPS for yourVPSIP in the URL.

• Get in there an click on LOGIN, in the top menu.
  The default credentials are admin/admin

Don't touch anything yet. You'll have plenty of time to play with the different tools later.

Now, we MUST change the admin password, as it is highly insecure !

5. Prepare to configure users

Due to inner security checks, we need to declare the VPS IP/port as "secure" to be able to enter the users management tool or you will see CSRF errors.

• In the SETTINGS menu, click on CRCON settings submenu
  or directly get to http://yourVPSIP:8010/#/settings/rcon-server

  You'll see a large editable textarea.
  The strange code in it is a config text, formatted in JSON.
  Stay cool : for the time being, we only are going to change a single line in it.

• Modify the server_url line, entering your URL (http://yourVPSIP:8010 for example).
  You must have quotation marks " around the url, and a comma , as the final character on the line.

  "server_url": "http://yourVPSIP:8010/",
  

• Click on the SAVE link, below the textarea
  (a green confirmation flag should pop in top-right corner of the window)
  If a yellow or red flag pops in, you have a syntax error : (watch the example above to get it right)

6. Restart CRCON

Yes. Restart it. This may sound strange, but it is mandatory :
to be taken in account, the server_url value you've just set has to be declared during the CRCON Docker containers start.

docker compose restart

7. Configure users

Now you can get into the CRCON users management tool, located at : http://yourVPSIP:8010/admin

You should be already logged in. If not, the credentials are still admin/admin.

Add a new user

• Click on the +Add link.
• Fill the Add User form
  Don't forget to enter the user's Steam ID (see image below) : it will be used by CRCON to identify this user as an admin.
• Click on the SAVE link

Once the user is created, you'll end up on that page:

Don't forget to give yourself the Superuser status and staff status if you intend to disable the admin account !

Please note that users won't be allowed to change their password by themselves unless you check staff status.

To change the password of a user, click on its name, then on this link (see image below):

You also can change your current password using the dedicated link (top-right red square below) :

Change default admin's password

• click on the page title "Django administration" to get back to the entry screen.
  (This is the same as going to http://yourVPSIP:8010/admin)
• click on Users, then on admin.
• Change the default admin password
  (you also can disable admin's account by unchecking the "Active" status,
  just make sure there's another user having Superuser status and staff status activated)
• Click on the SAVE button

8. Basic configuration is over !

Yes ! You did it ! You now have a fully working and secured CRCON ! Congratulations !

Take the time to explore all the menus and commands.

We know the UI isn't always intuitive and we would be glad if someone decide to help refreshing it ;)

You'll find a lot of things to customize in the "SETTINGS" menus.
(Most of the settings are described/explained on their own page).

If you have any question, do not hesitate to ask it on the CRCON Discord.

Have fun !

---

If you feel generous you can donate,
the money will be use to reward contributing developers or content creators
to create video tutorial, demos, documentation, etc.

---

Update to the latest version

Please join the CRCON Discord and follow announcements.
Sometimes, update instructions vary from standard.
If you are updating from an older version, you should review the announcements in order and make any non-standard changes in order.

Normal (most) updates

• Pull the changes from github

  git fetch --tags

• Check out a tagged release

  git checkout v9.4.1

• Get the newest Docker images

  docker compose pull

• Restart your containers
  • Linux on x86

    docker compose up -d --remove-orphans

  • Windows on x86

    docker compose -f docker-compose.yml -f docker-compose.windows.yml up -d --remove-orphans

  • Raspberry-Pi (32 bits) or any ARM32v7

    docker compose -f docker-compose.yml -f docker-compose.arm32v7.yml up --build -d --remove-orphans

  • Raspberry-Pi (64 bits) or any ARM64v8

    docker compose -f docker-compose.yml -f docker-compose.arm64v8.yml up --build -d --remove-orphans

You also can download the latest zip release and install it manually (not recommended)

Note: If you get git error messages when you pull, you have to resolve these before you can upgrade.
Unless you have been changing files, this should never happen.
Note: It's important you get the sources every time, or at least the docker-compose files, as new dependancies might have been introduced

Downgrade (in case of issue) to a previous version

Check the available versions numbers on Docker hub (or Github releases) :
https://hub.docker.com/r/maresh/hll_rcon/tags
https://github.com/MarechJ/hll_rcon_tool/releases

Edit your .env file and change TAGGED_VERSION from latest to a specific tagged release
(it must match the release tag on Docker hub):

TAGGED_VERSION=9.4.1

How to use

Demo video coming soon

There's a public endpoint available to anybody without password on http://yourVPSIP:7010/api/scoreboard

See User Guide for more information on how to use certain features of the app.

For power users

Multiple Game Servers

You can use one CRCON for multiple game servers, or have separate CRCONs for one (or more) game server, but they need to be set up differently, see below. For instance if you run multiple game servers (for instance US west, US east and/or an event server) it makes more sense to do one CRCON install rather than separate CRCONs for each game server.

One CRCON to manage multiple game servers

When using a single CRCON installation for multiple game servers all of your admin accounts will have equal access to all of them, and all of your data will be stored in a single database. This will make it difficult to separate your servers in the future (for instance if you are trying to use one CRCON for multiple communities by sharing a VPS) without starting from scratch and losing data. Note: Setting up more than 3 game servers in a single installation will require you to edit your .env and docker-compose.yml and add new sections for each server past the third.

Manage more than 3 servers

You can copy the the last server section in the docker-compose.yml file and paste it, while replacing all the _3 by _4, also add the required variable in your .env (copy a whole section and replace the _3 to _4 suffix) Also note that you must add this extra keys in your docker-compose.yml after HLL_REDIS_URL. And mind the DB number that should change with each server

      ....
      HLL_REDIS_URL: redis://redis:6379/1
      HLL_REDIS_HOST: redis
      HLL_REDIS_PORT: 6379
      HLL_REDIS_DB: 1
      ....

Multiple CRCON installations

Please see the Wiki for instructions on managing multiple installs on the same host machine.

Building your own Docker images

Docker images are hosted on Docker Hub, but if you're running a fork, have made local modifications, aren't using amd64 as your CPU architecture or the release you want isn't available for some reason, you can build your images locally.

Set environment variables

If you don't already have a .env file created use default.env to make a template and you'll be able to build the images without setting the :

cp default.env .env

If you don't have a .env you wou must set the following environment variables to something, or the build will fail with an error that looks like invalid tag ":": invalid reference format (just use a copy of default.env):

BACKEND_DOCKER_REPOSITORY=
FRONTEND_DOCKER_REPOSITORY=
TAGGED_VERSION=

Build the images

docker compose -f docker-compose.yml -f docker-compose.dev.yml build

Run it !

Once the images are built (which can take a considerable amount of time depending on your hardware specs), and once it's configured properly (see the installation part of this README), then simply use docker compose to create the containers:

docker compose up -d --remove-orphans

If you don't want to use docker compose (which you really should, it's just easier) then you would have to properly set/create/run the Docker containers yourself, consult Docker's documentation please.

Development environment

Pull requests are always welcome! It can be a bit tricky setting up a local environment and it is hard to contribute without having a HLL game server to connect to (and it's impossible to host one yourself, they won't release the server files).

Overview / Project Structure

The project is split up into several main components (the backend, frontend, services run by supervisord and redis and postgres that is shared across each image), and is intended to be run using Docker and docker compose. Each CRCON install can manage multiple game servers, and each game server (server 1, server 2, etc.) has its own set of images (backend_1, frontend_1, supervisor_1, etc.)

The backend is split into two major components, the rcon package and the rconweb package which is a Django web (WSGI) application.

rcon handles the implementation of the HLL RCON protocol and implements most of the core behavior/features that CRCON has.

rconweb handles all of the web portions (URL routing, authentication, sessions, etc.) once a HTTP request has been received by nginx in the frontend.

The supervisor container manages starting and restarting all of the optional/non optional (if you want a fully functioning CRCON) services, all of which are implemented in the rcon package or are a standalone program like rq or cron.

The frontend is a combination of nginx (used as a reverse proxy) and gunicorn web servers that handles all of the HTTP requests and serves all of the responses. The flow is incoming request -> nginx -> gunicorn -> nginx -> outgoing response. nginx handles serving all of the static content like HTML/css/images, and Django processes all of the API calls that return dynamic content.

rcon package

The rcon package relies on several core classes.

rcon.connection.HLLConnection handles connecting to the game server (IP, port and RCON password), xor encoding/decoding content and sending/receiving raw bytes over TCP sockets.

rcon.commands.ServerCtl is the parent class of Rcon and handles managing a pool of HllConnection instances, validating/converting low level stuff (like stripping tabs from user generated content for HLL tab delimited lists), automatically retrying commands that fail, and sending the raw commands (such as get profanity) to the game server.

rcon.commands.ServerCtl can be used without any database or redis connection, but is of limited use and not published separately.

rcon.rcon.Rcon inherits from ServerCtl and handles parsing/structuring the raw text received from the game server into meaningful data, interacting with the database, caching command results, etc.

CRCON is not an async (ASGI) web app (async) or multi core (multiprocessing), but it does support running multiple slow (to the game server) requests simultaneously through thread pools.

The rcon package also contains the implementation of most of CRCNs features, if you're not sure how something works, identify which API endpoint is doing the action, look in the URL routing in rconweb and you can see what parts of rcon are imported.

rconweb

The rconweb package is a Django web app that actually exposes all of the URL endpoints and imports from rcon as needed when interacting with the game server versus the local CRCON backend (redis, postgres, etc.).

Some endpoints are explicitly exposed, but some (Rcon methods) are implicitly exposed (rconweb.api.views.expose_api_endpoint).

supervisord

Due to the fact that Python is notoriously single threaded, some core parts of CRCON have been broken out into services that run in their own Python interpreter so they can take advantage of multiple cores/threads on the system. This also enables faster network access since each individual network request (to the game server, steam API, discord, etc.) blocks until completion.

Other portions are optional services and have been split so users have more control over what runs.

The services are managed by supervisord and run inside of their own (supervisor) container.

redis

Redis is used for two reasons in CRCON, caching and interprocess communication.

Every round trip to the game server can be significantly slow (in computing terms) and induces some amount of overhead on both CRCON and the game server.

Some commands are cached even if they have a very low cache time (such as retrieving logs from the game server) to avoid constantly reprocessing info on very short time frames and others are on a longer cache time because they rarely if ever change (such as the list of available maps from the game server).

This also condenses requests that occur almost simultaneously to be reduced to a single request that makes it to the game server, the remaining requests will be resolved from the cache (unless they happened before the first request has completed and cached its results).

Many portions of CRCON run in their own separate Python interpreter instances with their own section of memory, but by caching results with redis, we can communicate back and forth between interpreter instances. This is used both explicitly with rq to run tasks (such as recording game stats to the database, or bulk VIP uploads) and implicitly when something caches function results in redis and is accessed elsewhere.

postgres

CRCON uses postgres 12 with a default configuration.

Running a local/development instance

To run a local instance of CRCON without using the Docker images requires you to do some manual set up.

If you have never successfully run the complete CRCON environment from this install, you should do so first so that the database is created/initialized properly. (If you only ever plan on running the tests, you can do this without seeding the database). If you've done this, you can skip the database migrations/user creation below. It's just easier to do it this way, so I recommend it but it is optional.

Because of some configuration differences and how Docker determines environment variable precedence, I recommend using separate shells to run local instances and to run the full blown production Docker setup.

To avoid polluting your system Python, you should create/activate a virtual environment, I use pyenv but set up is outside the scope of this README.

Once the virtual environment is activated in your shell install all of the Python dependencies:

pip install -r requirements.txt

pip install -r requirements-dev.txt

Set environment variables

You can use dev.env as a template for what variables need to be set, and after filling in the missing portions, from your shell:

Or you can manually set them as specified in the sections below.

source dev.env

SERVER_NUMBER is an integral part of how CRCON works and is how data is segregated between servers in the database and is normally set in the compose files.

export SERVER_NUMBER=1

The HLL_DB_PASSWORD password must match what you set when the database was first created, or you can connect to the postgres docker container and reset the password for your database user if needed.

The default username and database name is rcon if you've seeded the database unless you've configured it differently.

export HLL_DB_PASSWORD=rcon_dev
export HLL_DB_NAME=rcon
export HLL_DB_USER=rcon
export HLL_DB_HOST=localhost
export HLL_DB_HOST_PORT=5432
export HLL_DB_URL=postgresql://${HLL_DB_USER}:${HLL_DB_PASSWORD}@${HLL_DB_HOST}:${HLL_DB_HOST_PORT}/${HLL_DB_NAME}

Running the development backend

Make sure you set all of the environment variables from the previous section(s).

You can sort of run a local instance without a game server to connect to, but so much depends on one that it's pretty pointless to try to do this without one.

export HLL_HOST=<your game server IP>
export HLL_PORT=<your game server RCON port>
export HLL_PASSWORD=<your game server RCON password>

If you didn't run the production environment first: Create the database tables (you only need to do this once, unless you've created new migrations).

PYTHONPATH=. alembic upgrade head
PYTHONPATH=. ./manage.py init_db
PYTHONPATH=. ./rconweb/manage.py makemigrations --no-input
PYTHONPATH=. ./rconweb/manage.py migrate --noinput

Alembic runs the database migrations which creates the tables, and init_db installs a postgres extension and sets default values for auto settings.

makemigrations and migrate creates the required Django database tables.

If you didn't run the production environment first: Create a superuser account and follow the prompts:

PYTHONPATH=. ./rconweb/manage.py createsuperuser

Set the redis environment variables:

export HLL_REDIS_HOST=localhost
export HLL_REDIS_HOST_PORT=6379
export HLL_REDIS_DB=1
export HLL_REDIS_URL=redis://${HLL_REDIS_HOST}:${HLL_REDIS_HOST_PORT}/1

Both the redis and postgres containers should be running (or you should have a redis and postgres installed/configured if you don't want to use the Docker images):

docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d redis postgres

Start the Django (backend) development web server:

DJANGO_DEBUG=true DEBUG=true PYTHONPATH=. ./rconweb/manage.py runserver --nothreading

If you've set all the environment variables correctly, initialized the database and started the Django web server, you'll see something similar to:

System check identified some issues:

WARNINGS:
api.DjangoAPIKey: (models.W042) Auto-created primary key used when not defining a primary key type, by default 'django.db.models.AutoField'.
        HINT: Configure the DEFAULT_AUTO_FIELD setting or the ApiConfig.default_auto_field attribute to point to a subclass of AutoField, e.g. 'django.db.models.BigAutoField'.
api.SteamPlayer: (models.W042) Auto-created primary key used when not defining a primary key type, by default 'django.db.models.AutoField'.
        HINT: Configure the DEFAULT_AUTO_FIELD setting or the ApiConfig.default_auto_field attribute to point to a subclass of AutoField, e.g. 'django.db.models.BigAutoField'.

System check identified 2 issues (0 silenced).
December 28, 2023 - 22:35:19
Django version 4.2.7, using settings 'rconweb.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

You can now open your browser (or use any other tool like Postman) to make API calls (http://127.0.0.1:8000/api/ will list all the available endpoints), or use the admin site (http://127.0.0.1:8000/admin/).

Any changes to the files in rcon/ or rconweb/ will cause the backend webserver to reload with the changes.

Running the development frontend

Once you have the development backend running, from another shell you can run the development frontend web server:

cd rcongui

npm install

npm start

You should see something similar to:

VITE v4.3.9  ready in 320 ms

➜  Local:   http://localhost:3000/
➜  Network: use --host to expose
➜  press h to show help

You can now open your browser (http://localhost:3000/) to use the frontend, any modifications to the frontend (javascript files) in rcongui will cause it to recompile/update.

Running services

Running the Django development web server only starts the backend web server which accepts HTTP requests, it won't start any of the services that would be started in a production environment.

Some of these services are required if you want the frontend to work as expected, such as log_loop (runs all of the hooks) or log_recorder that saves log lines to the database.

Each service you want to run either needs to be run in the background or needs to be run in a separate shell (don't forget to set environment variables in each shell)

# Calculates player stats for the scoreboard
PYTHONPATH=. ./manage.py live_stats_loop
# Runs hooks (on connected events, on kills, etc.)
PYTHONPATH=. ./manage.py log_loop
# If you want logs to be saved in the DB
PYTHONPATH=. ./manage.py log_recorder

Those service are run by supervisor in the production setup, so if you want more info check config/supervisor.conf

Running Tests

Unfortunately at this moment in time the database needs to be running for the tests to run. The tables don't actually need to exist.

From the root hll_rcon_tool directory:

PYTHONPATH=. DEBUG=TRUE pytest tests/

If you don't set PYTHONPATH you'll see errors similar to ModuleNotFoundError: No module named 'rcon'.

If you don't set DEBUG to a truthy value, you'll see errors about not being able to connect to redis.

To test if your changes will work with the production setup, start the whole stack

This should be done from a separate shell without the environment variables set, or they'll override what is set in your .env file because of how Docker determines precedence and you won't be able to connect to redis or postgres properly.

Building the frontend if you've made any changes to the javascript files or if the build cache isn't available can take a considerable amount of time.

docker compose -f docker-compose.yml -f docker-compose.dev.yml build

docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d

Now test on http://localhost:8010

General notes:

If you have problems with dependancies or versions of python or nodejs please refer to the respective Dockerfile that can act as a guide on how to setup a development environment.

If you need a refresher on which process needs what variables have a look at the docker-compose.yml file.