v2.0.0 CRCON v10 API Changes

This release is to account for the (upcoming) v10 CRCON release that contains API changes.

If you are still on a v9.x version of CRCON you shouldn't upgrade to this release yet! It won't work.

Upgrade Instructions

The config file(s) has a new value that has to be set, for each of your config files add a top level key (look at default_config.yml for an example) called name which can be set to whatever value you want.

This is used to create a separate database for each config file so that you can use the same webhook for multiple config files (thanks to @robbmanes)

Do this step after you git checkout v2.0.0 but before you create your containers again.

  git fetch --tags
  git checkout v2.0.0
  docker compose pull
  docker compose up -d

What's Changed

• Bump pydantic from 2.6.4 to 2.7.0 by @dependabot in #102
• Bump black from 24.3.0 to 24.4.1 by @dependabot in #104
• Bump pytest from 8.1.1 to 8.2.1 by @dependabot in #111
• Bump black from 24.4.1 to 24.4.2 by @dependabot in #108
• Bump pre-commit from 3.7.0 to 3.7.1 by @dependabot in #110
• Bump pydantic from 2.7.0 to 2.7.2 by @dependabot in #112
• Bump sqlalchemy from 2.0.29 to 2.0.30 by @dependabot in #109
• Create multiple databases for each configuration. by @robbmanes in #105
• Maint/update readme default config by @cemathey in #115
• Format Python code with psf/black push by @github-actions in #113
• Update for upcoming CRCON v10 API changes by @cemathey in #116
• Maint/rcon v10 by @cemathey in #125
• Maint/rcon v10 by @cemathey in #131
• Bump sqlalchemy from 2.0.30 to 2.0.32 by @dependabot in #130
• Bump trio from 0.25.0 to 0.26.1 by @dependabot in #129
• Bump pytest from 8.2.1 to 8.3.2 by @dependabot in #128
• Bump pre-commit from 3.7.1 to 3.8.0 by @dependabot in #127
• Bump pydantic from 2.7.2 to 2.8.2 by @dependabot in #123

New Contributors

• @robbmanes made their first contribution in #105

Full Changelog: v1.7.0...v2.0.0

v1.7.0 U15 Maps

This just adds map info for the new maps coming in U15, as well as adding info for El Alamein and Driel skirmish that I forgot about.

Upgrade Instructions

git fetch --tags
git checkout v1.7.0
docker compose pull
docker compose up -d --remove-orphans

What's Changed

• Add missing maps by @cemathey in #103

Full Changelog: v1.6.2...v1.7.0

v1.6.2 VIP Count By Team

v1.6.2

This release bumps some dependency versions and adds the ability to show VIP count by team.

Upgrade instructions

If you want to include the VIP count by team you will have to update your gamestate embed list in your config files, you can see examples of the new fields in default_config.yml.

git fetch --tags
git checkout v1.6.2
docker compose pull
docker compose up -d

v1.4.0

What's Changed

Features

• Add a compose file by @cemathey in #53
• Log inability to connect to API on startup by @cemathey in #52

Bug Fixes

• Fix night map typos by @cemathey in #51

• Bump tomlkit from 0.12.1 to 0.12.3 by @dependabot in #48

• Bump httpx from 0.25.0 to 0.25.2 by @dependabot in #49

• Bump black from 23.10.1 to 23.12.0 by @dependabot in #54

• Bump trio from 0.22.2 to 0.23.2 by @dependabot in #55

• Bump version number by @cemathey in #56

Full Changelog: v1.3.0...v1.4.0

v1.3.0

What's Changed

• Add player stats
• Less likely to leave orphaned Discord messages when it restarts

Upgrade Instructions

1. Perform a standard upgrade, don't run your container yet https://github.com/cemathey/hll_server_status#updating
2. Add the new display.player_stats section to your configuration files from default_config.toml
3. Run your container

Full Changelog: v1.2.3...v1.3.0

v1.2.3 Night Map URLs / Miscellaneous

• Adds the URLs for night maps (once they're merged/released in CRCON)
• Properly bootstrap missing directories on new installs

Full Changelog: v1.2.2...v1.2.3

v1.2.2 U14.x night map names

• Adds U14.x night map names
• Uses GET requests instead of POST for the map rotation (avoids an issue with a future CRCON release)

v1.2.1

Fixes some miscellaneous bugs, logging and uses a different Discord webhook package for better async support.

v1.1.0

Adds the U14 map names for the UK release.

It will now not explode when any new maps are released and still try to guess the correct map image to pull from CRCON.

Adds a new config file setting: score_format_ger_uk = "<:icoT_UK:1114060867068235807> {0} : <:icoT_GER:1060219972871278602> {1}" to allow you to tweak the score format for UK maps.

Release instructions:

• Add the score_format_ger_uk setting to your config
• Follow the upgrade steps in the README

General Stability Refactor

Change Note Summary

• Update README
• Config files will now be refreshed on a user configurable timer to allow updates to (existing) files without restarting the entire tool, adding a new config file will still require restarting the tool.
• Updated default_config.yml to make it easier to read
• Won't break if you forget the trailing / on your CRCON URL
• Added a footer configuration section to each embed in default_config.yml to better support multiple servers using the same Discord webhook so you can distinguish the messages
• You can set the log level you wish to see (DEBUG, INFO, ERROR, etc.) when running the container by setting the LOGURU_LEVEL environment variable, I wouldn't recommend setting this below ERROR

Upgrading

Since there's been some major changes to default_config.yml I would recommend backing up your old config file, and making a new copy of default_config.yml.

Follow the standard upgrade instructions:

git pull

Fix your config files, then:

docker build --tag hll_server_status:latest .
docker stop hll_server_status
docker rm hll_server_status
docker run -d --env LOGURU_LEVEL=INFO --init --name hll_server_status -v $(pwd)/logs:/code/logs -v $(pwd)/config:/code/config -v $(pwd)/messages:/code/messages --restart unless-stopped hll_server_status