Skip to main content

carim-discord-bot

A simple Discord bot that can communicate with BattlEye via RCon. Support can be found in the Carim Discord.

Table of Contents

Install

  1. Install Python 3.7 or 3.8
  2. Run pip3 install carim-discord-bot
  3. Run carim-bot --setup and follow the instructions

Alternatively, you can deploy using Heroku.

Update

  1. Run pip3 install carim-discord-bot -U
  2. Run carim-bot --setup configuration to see if any options have changed
  3. Update your configuration file accordingly
  4. Restart the service if you have one

Features

  • Log RCon communication to Discord
  • Send RCon commands to the server via Discord
  • Schedule RCon commands to be executed by relative time or aligned with the clock
  • Skip the next instance of a scheduled command
  • Perform safe shutdowns of the server, including kicking players and locking
  • Establish cross-chat that links the in-game chat and a Discord channel

Usage

commands:
--help                     displays this usage information
--about                    display some information about the bot
--version                  display the current version of the bot

admin commands:
--command [command]        send command to the server, or list
                           the available commands
--shutdown [seconds]       shutdown the server in a safe manner
                           with an optional delay; notice messages
                           are broadcasted to the server at
                           60, 30, 20, 10, 5, 4, 3, 2, and 1 minute
                           until shutdown
--status                   show current scheduled item status
--skip index               skip next run of scheduled command
--kill                     make the bot terminate

Examples

--command "say -1 Hello everybody!"
# this sends a message to everybody on the server
# notice the quotes around the command

--command players
# gets a list of currently connected players

--shutdown 3600
# schedules the server to be shutdown in an hour

Scheduled Commands

Examples

Send a global server message every 5 minutes

{
  "command": "say -1 Hello everybody!",
  "interval": 300
}

Shutdown the server every 3 hours starting at 00:00

{
  "command": "safe_shutdown",
  "delay": 3600,
  "interval": 10800,
  "with_clock": true,
  "offset": 3600
}

Metadata

Release files for carim-discord-bot 2.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for carim-discord-bot 2.2.5
File Size Uploaded Provenance Actions
carim-discord-bot-2.2.5.tar.gz 28.2 kB Without provenance Details for carim-discord-bot-2.2.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for carim-discord-bot 2.2.5
File Interpreter ABI Platform Actions
carim_discord_bot-2.2.5-py3-none-any.whl Python 3 none any Details for carim_discord_bot-2.2.5-py3-none-any.whl

Total release size: 66.3 kB

Release files / carim-discord-bot-2.2.5.tar.gz

Download URL carim-discord-bot-2.2.5.tar.gz
Size 28.2 kB
Tags Source
SHA-256 checksum
How to use checksums
a68e5538dcae30447397665f932cbf6c1f0a8305882b9498e490dc4200eac036
BLAKE2b-256 checksum
How to use checksums
f3c6658692f35e94810d10febbf9bf8a396ebfd4c39ae366036b67b10ede5baa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

Release files / carim_discord_bot-2.2.5-py3-none-any.whl

Download URL carim_discord_bot-2.2.5-py3-none-any.whl
Size 38.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
932bed7ca51c6fe42f78500c0b12b1b975d60ed1f72430266cb40beccd79adc8
BLAKE2b-256 checksum
How to use checksums
d78ad0ad9a6a15f58db4a64704a687a8e9d35f8e64e7314eaf422db746bb65d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

Security for carim-discord-bot 2.2.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.2.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page