HLL_CRCON_Forbid_role

Unofficial plugin for the Hell Let Loose (HLL) CRCON

Forbids role(s) access to defined players.

---

Important

• The shell commands given below assume your CRCON is installed in /root/hll_rcon_tool
  You may have installed your CRCON in a different folder.
  If so, you'll have to adapt the commands below accordingly.

• Always copy/paste/execute commands ⚠️ one line at a time ⚠️

Installation

1/3 - Log into your CRCON host machine using SSH

• See this guide if you need help to do it.

2/3 - Download files

• Copy/paste/execute these commands :

  cd /root/hll_rcon_tool

  wget -N https://raw.githubusercontent.com/ElGuillermo/HLL_CRCON_restart/refs/heads/main/restart.sh

  mkdir -p custom_tools

  cd custom_tools

  wget -N https://raw.githubusercontent.com/ElGuillermo/HLL_CRCON_custom_common_functions.py/refs/heads/main/common_functions.py

  wget -N https://raw.githubusercontent.com/ElGuillermo/HLL_CRCON_custom_common_translations.py/refs/heads/main/common_translations.py

  wget -N https://raw.githubusercontent.com/ElGuillermo/HLL_CRCON_Forbid_role/refs/heads/main/hll_rcon_tool/custom_tools/automod_forbid_role.py

  wget -N https://raw.githubusercontent.com/ElGuillermo/HLL_CRCON_Forbid_role/refs/heads/main/hll_rcon_tool/custom_tools/automod_forbid_role_config.py

3/3 - Edit /root/hll_rcon_tool/config/supervisord.conf

• Add this section (wherever you want, but along with the others [program:...] is preferable)

  [program:automod_forbid_role]
  command=python -m custom_tools.automod_forbid_role
  environment=LOGGING_FILENAME=custom_tools_automod_forbid_role_%(ENV_SERVER_NUMBER)s.log
  startretries=100
  startsecs=10
  autostart=false
  autorestart=true

Configuration

1/2 - Edit /root/hll_rcon_tool/custom_tools/automod_forbid_role_config.py

• Set the parameters to fit your needs (see inner comments for guidance).

2/2 - Rebuild and restart CRCON Docker containers

• Copy/paste/execute these commands :

  cd /root/hll_rcon_tool

  sh ./restart.sh

Tip

If you don't want to use the restart.sh script :

• Copy/paste/execute these commands :

cd /root/hll_rcon_tool

sudo docker compose build && sudo docker compose down && sudo docker compose up -d --remove-orphans

---

Maintenance

Disable this plugin

• Revert the changes made in Installation 3/3

--

Modify code or settings

❗ Any change to these files requires to rebuild and restart CRCON Docker containers (same procedure as in Configuration 2/2) :

• /root/hll_rcon_tool/custom_tools/common_functions.py
• /root/hll_rcon_tool/custom_tools/common_translations.py
• /root/hll_rcon_tool/custom_tools/automod_forbid_role.py
• /root/hll_rcon_tool/custom_tools/automod_forbid_role_config.py

--

Upgrade CRCON

This plugin requires a modification of original CRCON file(s).
❗ If any CRCON update contains a new version of this file(s), the usual CRCON upgrade procedure will FAIL.

To successfully upgrade your CRCON, you will need to undo the changes in :

• /root/hll_rcon_tool/config/supervisord.conf

Undo the changes

• Copy/paste/execute these commands :

  cd /root/hll_rcon_tool

  cp config/supervisord.conf config/supervisord.conf.backup

  git restore config/supervisord.conf

Upgrade

• Follow the official upgrade instructions given in the new CRCON version announcement.
• Don't restart CRCON Docker containers yet (don't execute docker compose up -d).

Reapply changes

• copy/paste the changes from
  /root/hll_rcon_tool/config/supervisord.conf.backup
  into
  /root/hll_rcon_tool/config/supervisord.conf
• Rebuild and restart CRCON Docker containers (same procedure as in Configuration 2/2).
• If everything works as intended, you can delete the backup file :
  • Copy/paste/execute these commands :

    cd /root/hll_rcon_tool
    

    rm config/supervisord.conf.backup