Skip to main content

Discord bot that provides DayZ RCon capabilities and cross chat

Project description

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
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for carim-discord-bot, version 2.1.7
Filename, size File type Python version Upload date Hashes
Filename, size carim_discord_bot-2.1.7-py3-none-any.whl (38.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size carim-discord-bot-2.1.7.tar.gz (27.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page