Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 5.08 KB

README.md

File metadata and controls

110 lines (83 loc) · 5.08 KB
Raw

🦇 BuffyBot 🧛‍♀️

"If the apocalypse comes, beep me"
A Discord bot for keeping track of your place during Buffy The Vampire Slayer marathons 🧛‍♀️

📖 Table of Contents

Click to expand contents

🖥️ Functionality

BuffyBot uses slash commands, the available ones are

  • /buffy-save season episode: Saves your progress in the current season. e.g /buffy-save 1 1 to save that you are watching or just finished Season 1 Episode 1.
  • /buffy-progress: Posts a progress bar with your status through finishing Buffy!
  • /buffy-next: Posts the season, episode number and title of the next episode with a link to the Wikipedia page.
  • /buffy-current: Posts the season, episode number and title of the last saved episode with a link to the Wikipedia page.

🏃 How to run BuffyBot locally

The bot can also be run locally on a device, which requires Python and Poetry to be installed. BuffyBot will only be online as long as the command is running, so if you turn your computer off or close the process, BuffyBot will go offline too! However, this method is good for testing and experimentation if you don't want to faff around with Heroku 🦇

  1. First, clone the repo using git clone https://github.com/ekwska/buffybot
  2. Next install the dev dependencies:
  1. Create a new Discord Application in the Discord Developer Portal
  • Name your app (e.g SpikeForever) click the Create App button
  • Copy the apps CLIENT ID (it is called APPLICATION ID in discord) somewhere
  • Click on the Bot section in the sidebar -- UNCHECK Public bot, unless you want it to be public -- CHECK Message Content Intent, this is critical for the apps functionality
  • Copy the bot's TOKEN somewhere. If you forget it, you will need to regenerate it.
  1. Rename the file .env.example to .env, and replace the value of DISCORD_TOKEN with the bots TOKEN you copied above.
  2. Now invite the bot to any server where you have admin privileges using the below link, making sure to replace CLIENT_ID with your client ID from above.
https://discord.com/api/oauth2/authorize?client_id=CLIENT_ID&permissions=2147552256&scope=bot

This will give the bot:

  • bot scope
  • Read Messages/View Channels permission
  • Send Messages permission
  • Read Message History permission
  • Use Slash Commands permission
  1. Open a terminal and navigate to the buffybot folder using cd buffybot
  2. Run poetry install
  3. Run poetry run buffybot, and you should see something like so (the bots Discord name and # identifier will be different depending on what you named the bot):
$ $ poetry run buffybot
2023-10-30 16:15:39 WARNING  discord.state Guilds intent seems to be disabled. This may cause state related issues.
2023-10-30 16:15:39 WARNING  discord.client PyNaCl is not installed, voice will NOT be supported
2023-10-30 16:15:39 INFO     root Main table of seasons/episodes exists, loading!
/home/bird/Documents/src/buffybot/buffybot/bot.py:20: RuntimeWarning: coroutine 'BotBase.add_cog' was never awaited
  bot.add_cog(BuffyBot(bot))
RuntimeWarning: Enable tracemalloc to get the object allocation traceback
2023-10-30 16:15:39 INFO     discord.client logging in using static token
2023-10-30 16:15:39 INFO     discord.client logging in using static token
2023-10-30 16:15:40 INFO     discord.gateway Shard ID None has connected to Gateway (Session ID: bc12366652ca2f664b8a75aa7586b416).
2023-10-30 16:15:40 INFO     discord.gateway Shard ID None has connected to Gateway (Session ID: bc12366652ca2f664b8a75aa7586b416).
2023-10-30 16:15:42 INFO     root BuffyBot#3743 has connected to Discord! Version 2.3.2
2023-10-30 16:15:42 INFO     root Main table of seasons/episodes exists, loading!
2023-10-30 16:15:42 INFO     root BuffyBot#3743 has loaded the BuffyBot extension!
  1. You should have a working BuffyBot! Test it out in your server by using:
  • /buffy-save 1 1 to save that you are on the first episode.
  • Then /buffy-progress to show how far you are through Buffy.
  • And then /buffy-next to show you the title, season and episode number of the next episode (and a handy wikipedia link).

You're now ready to slay some vampires and destroy pass high school, have fun! 🩸

🏥 Support

If you run into any issues, please open a Pull Request 🐛

Doc formatting and setup instructions inspired by RiTA-DiscordBot ❤️