carim-discord-bot


Namecarim-discord-bot JSON
Version 2.1.7 PyPI version JSON
download
home_pagehttps://github.com/schana/carim-discord-bot
SummaryDiscord bot that provides DayZ RCon capabilities and cross chat
upload_time2020-11-21 20:13:37
maintainer
docs_urlNone
authorNathaniel Schaaf
requires_python<3.9.*,>=3.7.*
licenseApache Software License
keywords discord dayz rcon
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # carim-discord-bot

A simple Discord bot that can communicate with BattlEye via RCon. Support can be found
in the [Carim Discord](https://discord.gg/kdPnVu4).

Table of Contents
* [Install](#install)
* [Update](#update)
* [Features](#features)
* [Usage](#usage)
  + [Examples](#examples)
* [Scheduled Commands](#scheduled-commands)
  + [Examples](#examples-1)

## Install

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

Alternatively, you can [deploy using Heroku](https://github.com/schana/carim-discord-bot-heroku).

## Update

1. Run `pip3 install carim-discord-bot -U`
1. Run `carim-bot --setup configuration` to see if any options have changed
1. Update your configuration file accordingly
1. 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
```json
{
  "command": "say -1 Hello everybody!",
  "interval": 300
}
```

Shutdown the server every 3 hours starting at 00:00
```json
{
  "command": "safe_shutdown",
  "delay": 3600,
  "interval": 10800,
  "with_clock": true,
  "offset": 3600
}
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/schana/carim-discord-bot",
    "name": "carim-discord-bot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.9.*,>=3.7.*",
    "maintainer_email": "",
    "keywords": "discord,dayz,rcon",
    "author": "Nathaniel Schaaf",
    "author_email": "nathaniel.schaaf@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/35/6d/81dae9f46cee1ac440bdebf2ef0063f74503de3be5a3d5cf62c07f035bf8/carim-discord-bot-2.1.7.tar.gz",
    "platform": "any",
    "description": "# carim-discord-bot\n\nA simple Discord bot that can communicate with BattlEye via RCon. Support can be found\nin the [Carim Discord](https://discord.gg/kdPnVu4).\n\nTable of Contents\n* [Install](#install)\n* [Update](#update)\n* [Features](#features)\n* [Usage](#usage)\n  + [Examples](#examples)\n* [Scheduled Commands](#scheduled-commands)\n  + [Examples](#examples-1)\n\n## Install\n\n1. Install Python 3.7 or 3.8\n1. Run `pip3 install carim-discord-bot`\n1. Run `carim-bot --setup` and follow the instructions\n\nAlternatively, you can [deploy using Heroku](https://github.com/schana/carim-discord-bot-heroku).\n\n## Update\n\n1. Run `pip3 install carim-discord-bot -U`\n1. Run `carim-bot --setup configuration` to see if any options have changed\n1. Update your configuration file accordingly\n1. Restart the service if you have one\n\n## Features\n\n* Log RCon communication to Discord\n* Send RCon commands to the server via Discord\n* Schedule RCon commands to be executed by relative time or aligned with the clock\n* Skip the next instance of a scheduled command\n* Perform safe shutdowns of the server, including kicking players and locking\n* Establish cross-chat that links the in-game chat and a Discord channel\n\n## Usage\n\n```\ncommands:\n--help                     displays this usage information\n--about                    display some information about the bot\n--version                  display the current version of the bot\n\nadmin commands:\n--command [command]        send command to the server, or list\n                           the available commands\n--shutdown [seconds]       shutdown the server in a safe manner\n                           with an optional delay; notice messages\n                           are broadcasted to the server at\n                           60, 30, 20, 10, 5, 4, 3, 2, and 1 minute\n                           until shutdown\n--status                   show current scheduled item status\n--skip index               skip next run of scheduled command\n--kill                     make the bot terminate\n```\n\n### Examples\n\n```\n--command \"say -1 Hello everybody!\"\n# this sends a message to everybody on the server\n# notice the quotes around the command\n\n--command players\n# gets a list of currently connected players\n\n--shutdown 3600\n# schedules the server to be shutdown in an hour\n```\n\n## Scheduled Commands\n\n### Examples\n\nSend a global server message every 5 minutes\n```json\n{\n  \"command\": \"say -1 Hello everybody!\",\n  \"interval\": 300\n}\n```\n\nShutdown the server every 3 hours starting at 00:00\n```json\n{\n  \"command\": \"safe_shutdown\",\n  \"delay\": 3600,\n  \"interval\": 10800,\n  \"with_clock\": true,\n  \"offset\": 3600\n}\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License",
    "summary": "Discord bot that provides DayZ RCon capabilities and cross chat",
    "version": "2.1.7",
    "split_keywords": [
        "discord",
        "dayz",
        "rcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3812762757af8fef52cc3e84342b5d9c",
                "sha256": "79de0b1af4b2df0f57747aae9017eccb12af96cc9abe29f4ecf7c0936a431509"
            },
            "downloads": -1,
            "filename": "carim_discord_bot-2.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3812762757af8fef52cc3e84342b5d9c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.9.*,>=3.7.*",
            "size": 38374,
            "upload_time": "2020-11-21T20:13:36",
            "upload_time_iso_8601": "2020-11-21T20:13:36.999388Z",
            "url": "https://files.pythonhosted.org/packages/8d/a7/74758b8050479057f49daa0acfa5228a9d7faec826fde1fceca6eec73893/carim_discord_bot-2.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d5aac1a9d42bf88bb24501cfc2177bcf",
                "sha256": "26c694c9ecf71cdc32caee96ef1a7e734a1ebf016642e2b2254856a4e1c3c9ef"
            },
            "downloads": -1,
            "filename": "carim-discord-bot-2.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "d5aac1a9d42bf88bb24501cfc2177bcf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.9.*,>=3.7.*",
            "size": 27282,
            "upload_time": "2020-11-21T20:13:37",
            "upload_time_iso_8601": "2020-11-21T20:13:37.983417Z",
            "url": "https://files.pythonhosted.org/packages/35/6d/81dae9f46cee1ac440bdebf2ef0063f74503de3be5a3d5cf62c07f035bf8/carim-discord-bot-2.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-21 20:13:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "schana",
    "error": "Could not fetch GitHub repository",
    "lcname": "carim-discord-bot"
}
        
Elapsed time: 0.17935s