Skip to content

Latest commit

 

History

History
99 lines (77 loc) · 4.77 KB

README.md

File metadata and controls

99 lines (77 loc) · 4.77 KB
Raw

PunyBot

Current Feature List Per Plugin

Agreement

Features

  • Post a message marked as an "Terms and Conditions" to be given access to private channels
  • Upon clicking the button, user recieves pop up, asking for information, and upon submission is saved to DB, and then roles are swapped for the one granting channel(s) acess.

Control

  • Process control, please ignore.

Core

Features

  • Rotates the bot user's status based on player count on certain steam games. The games used are the ones in the config file with the status_apps key.
  • Logs to a channel that the bot has connected/resumed to discord's gateway
  • Handles basic commands (chat commands that start with "!")
  • Assigns member role based on the configured role in roles.SERVER_ID.rules_accepted once they click the "agree to rules"
  • Handles the role modification for the role selection menu based on the roles.SERVER_ID.select_menu key.

Commands

  • !echo <msg_id> [channel_id] [topic] - Will echo a message into either the same channel or a different channel. If channel is a forum channel, the topic will be used as the new thread's title.
  • !forcestatus - Sometime's discord's precenses break, this kills the internal scheduler and restarts it
  • !sendrulesbuttonmsg will be replaced - Sends the rules agreement message with correct message components
  • !sendrulesmsg will be replaced - Sends the rules agreement message without button
  • !sendmenumsg will be replaced - Sends the select menu message for the role selection.

Kaboom

Features

  • When the appropriate command/menu action is completed, the bot will mark a message with a 💣 emoji, and delete it following a user selected period of time.

Commands

  • /kaboom message_id time - Will mark the message for deletion. It's a slash command with a up to date message selection.
  • !setupcmds - Registers the menu/chat commands to the guild it is ran in.

Media

Features

  • Pools steam news into channels using webhooks.
  • Pools news from various RSS feeds into channels.
  • Stores cache in a sqlite DB to ensure no duplicates
  • Note: Twitter disabled due to unknown API status

Pickup

Features

  • Allows users to create "games" via a interaction menu in an "active games" channel.
  • Interactively guides users to creating a channel
  • Allows users to acquire a "looking-for-group" group to get pinged about new games
  • When a user joins a game, they are given permissions to the joined game's voice channel
    • The host has a menu at the top of the channel allowing them to select a new host, change regions, end game, edit server information, and leave (for normal players only)
  • Channels/Active game messages are cleaned up either after a game ends, or a set amount of time passes.

Before starting the bot

  1. fill out the config-example.yaml file and rename/copy to config.yaml

  2. If using a compose file:

    • Fill out the env variables in the compose file, or in a .env file.
    • Proceed to next section

    If wanting to run locally:

    • Proceed to running bot locally from source

Running the bot with Docker (and Compose)

It is highly recommended to use docker-compose to run the production or local (dev) instances of the bot. This ensures you have all the dependencies required, and that local works as it should in production.

The production.yml docker-compose file expects to map the config directory to the container. No extra invocations are needed. The development.yml docker-compose file will map both the config and a data directory to the container for ease of access to the sqlite database for development.

Running the bot locally from source.

Locally, the bot uses poetry for dependencies, which would also make running the bot easier.

  1. Because we aren't running on docker, add the config value "token" at the top of your config.yaml file with your discord bot token.
  2. poetry install/poetry update
  3. poetry run python -m disco.cli --config config/config.yaml
    • Note: Only the bot token won't load from a .env file, the other tokens will.

WIP

  • Redo all commands into slash commands

    • echo
      • /echo <msg:Snowflake> [channel:Channel] [Topic:Str..]
    • sendtemplatemessage
      • /sendtemplate <msg_template:str> [interaction_section:str]
        • Auto complete for both msg_template and interaction_section

  • More social webhooks:

    • Reimplement Twitter
    • Instagram
    • Facebook
    • YouTube
    • Twitch (Official streams?)

  • Configurable Message components (Buttons)