Trash Panda Bot

Trash Panda Bot

A little trash panda to randomly post in your Discord server.
Explore the docs »
· Report Bug · Request Feature

About The Project

This project houses a bot for Discord that is used to post funny and relatively out of pocket short stories about members within your server. The bot first decides whether this is a solo story or if it contains multiple people. From there a short bit of lore is generated regarding users who are selected at random.

The purpose of this project was to introduce an element of humour, however, if some users do not want to be randomly tagged and slandered, then the bot also provides a very simple blacklist mechanism.

(back to top)

Built With

• NodeJS
• Discord API

(back to top)

Getting Started

Prerequisites

Discord bot, trash-panda-bot is built using NodeJS and the Discord API, as such it is assumed that you already have Node installed in your local environment. To install the required packages, using the following command.

• npm

  npm install

Environment Variables

For the environment variables used within the repository, you can either request from any of the contributors (if contributing to this specific bot) the environment variables. Alternatively, if implementing this bot for your own channels or servers, you will find the following links useful in generating your own variables.

• Discord Bot API Guide
• Fetching Discord Channel IDs

Installation

1. Follow the instructions from Discord to generate a free token.

2. Clone the repo

   git clone https://github.com/jamestkelly/trash-panda-bot.git

3. Install NPM packages

   npm install

4. Create a file called config.json and add your token to it.

   {
     "BOT_TOKEN": "EXAMPLE0123adhgajksdcTOKEN"
   }

5. Run the bot locally to test if it works prior to deployment.

   node index.js # Run the bot on your local host

(back to top)

Usage

This project can be used within your own Discord servers by connecting them and adding the bot to any given channel. To edit questions, simply edit the questions.txt file to change which questions the bot will select from at random to ask people within your server.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Develop trash-panda-bot in its most basic form, i.e. ability to read and write to a channel.
• Write up several funny and unrealistic things for the bot to post.
  • Create enough flavour texts so that the bot is unlikely to repeat itself.
• Finalise Version 1.0 of the bot.
  • Deploy the bot to a cloud provider (GCP).
  • Implement GitHub Actions pipeline for automatic updates upon approval of merge requests (MRs).
  • Release the bot.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jim Kelly - [email protected]

Project Link: https://github.com/jamestkelly/trash-panda-bot

(back to top)

Acknowledgments

Notable Contributors

• Aaron Dougals
• Jimmy Hoang
• Rohan Singh

Service Providers

• Discord

(back to top)