discord-bot

Automated user bot for Discord written in Python. Refer below for installation and example usages. It strongly advised to read the whole document before running any commands.

⚠️ Please note that using the tool for outside of its indented purpose may lead to your account being banned by Discord, as stated in Discord on Automated user accounts.

Contents

📖 Requirements
💭 Usage
🔍 Documentation
💬 Message format

📖 Requirements

There are several requirements needed to successfully configure and use the tool.

Authentication token - Discord user authentication token. Follow this guide on how to obtain the token.

💭 Usage

$ discord-bot --help

Usage: discord-bot.py [OPTIONS] COMMAND [ARGS]...

  Discord CLI bot that programmatically controls user events. It allows
  advanced control of Discord APIs for provided user. Initially, you will
  have to authenticate user by providing a valid token via

  $ ./discord-bot auth

  Usages:
  - Sending formatted messages to users of servers based on searched parameters
  - Inspect users you can interact with

  Notes:
  - Users are gathered from public server text channels message history.
    The larger the depth of messages, more users will be notified.
    The cost of this is slower performance.
    This is the only way to obtain list of users from servers.
  - This tool is against Discord policies and can result in account suspension.
  - To obtain user authentication token, follow https://bit.ly/31Vcno0

Options:
  --help  Show this message and exit.

Commands:
  frequest  Sends friend requests to users on servers matching provided
            filters

  info      Displays application information
  init      Initializes the environment with example configs.
  list      Lists server users matching provided filters
  login     Authenticate user against Discord API
  notify    Sends formatted message to server users matching provided filters
  profile   Displays public information of currently logged user

There are two ways to install & use this package, either via binaries or via source code.

Source - Use native Python source code to extend and customize the tool. Advised for advanced configuration and development.
Binaries - Use OS-native binaries to interact with the tool. Best to use if you only want to consume the library.

Source

Use this step if you would like to extend and contribute. You will have to install required packages in order to properly run and customize the code.

Requirements

Python >= 3.6.9

Launch your OS-native development environment and start hacking:

### Install
$ git clone https://github.com/fhivemind/discord-bot
$ cd discord-bot
$ python -m pip install -r requirements.txt

### Verify
$ python discord-bot info

🎯 Environment information

   Version: v1.2.2

Docker

You can also run discord-bot as Docker executable, by running following:

$ alias discord-bot="docker run fhivemind/discord-bot:1.2.2"
$ discord-bot info

🎯 Environment information

   Version: v1.2.2

Binaries

You can find all the binaries under release page. Download the necessary files to start hacking.

Launch your OS native shell in the same folder where the binary is located and verify the installation:

$ discord-bot info

🎯 Environment information

   Version: v1.2.2

Building procedures

You can build the library by simply running make. This will generate OS-specific binaries under ./dist folder.

🔍 Documentation

Short list about available CLI commands and their usages is available under docs folder.

💬 Message format

The format of the private messages that will be sent to users is defined by FORMAT.md. To add your custom message, update this file.

All attributes formatted as __ATTR__ will be replaced by their respective definition value.
Currently supported attributes include:

Format	Value
`__USERNAME__`	User mention, e.g. @fhivemind

Auhor: Ramiz Polic (fhivemind)
Version: v1.2.2

ramizpolic / discord-bot