Blacklist-Butler

This is a Blacklist manager for in channel blacklists. Maybe your game or similar doesn't have a way to manage users you need to remember. If that is the case then Blacklist Butler will be your new friend that easily stores your names or similar in a text channel.

How to add the bot to your server

Go to a link bellow and pick the server you want to add the bot to.

• Least permissions (Recommended)
• For possible future features
• All permissions (Administrator)

How to setup and run locally

1. Open a command prompt in the projects root folder.
2. New make sure you have Bun installed and run 'bun install'.
3. Now go to Discord and make a new application with whatever name and so on that you want.
4. Save the token and make sure not to share it with anyone.
5. Next make a .env file in the project root folder and add 'DISCORD_TOKEN=' followed by your token from you just saved.
6. Pick a backend with 'STORE_TYPE=local', 'STORE_TYPE=firebase', or 'STORE_TYPE=supabase'. If it is omitted, the bot falls back to local storage.
7. For Firebase, also set 'FIREBASE_STORAGE_BUCKET' and either 'FIREBASE_SERVICE_ACCOUNT_BASE64' or 'GOOGLE_APPLICATION_CREDENTIALS'.
8. For Supabase, set 'SUPABASE_URL' and 'SUPABASE_SERVICE_ROLE_KEY', then run the SQL in 'supabase/schema.sql' in the Supabase SQL editor.
9. Now just run 'bun run start' and the bot will be up and running (only this step is needed in the future)
10. To add the bot to your server, go to your bot on Discord again.
11. Go to OAuth2 -> URL Generator.
12. For the scope pick bot and application.commands.
13. For the permissions pick Read Messages/View Channels, Send Messages, Manage Messages.
14. Copy and save the link.
15. Enter the link in a web browser and pick the server you want to add the bot to.

How to make a blacklist channel

1. Make a channel named blacklist.
2. (optional) set a prefix with command /blacklist set-prefix
   1. A prefix is a string that will be added to the start of the header of the message.
   2. Don't recommend doing it later, as support hasn't been added so the blacklist is updated.
3. Init the list with /blacklist inti.
   1. if the chat has an old blacklist, then use the option has-old-list set to true.
   2. If the list should be initialized with additions, then use the option has-old set to true. Messages in the channel should be in the format add <name> to be added on initialization.
4. Use the /blacklist print command (recommend not sending any options).
   1. clean set true, will remove an old list if exists.

How to add and remove names

Simply use the /add or /remove commands and give the name that you want to add or remove from the list.

Other commands to know

-Role permissions

To allow non-administrator roles access to the bot's admin functions, use the /add-admin-role and /remove-admin-role commands. Simply pick the role you wish to give or deny access to the admin commands.

-User and Server information

Want to know what your discord id or the servers id, then use the /user or /server commands.

-Ping Pong

Want to play a little ping pong? Just use the command ping, and the bot will reply with pong.

Supabase schema and migration

Run the SQL in 'supabase/schema.sql' before starting the bot with 'STORE_TYPE=supabase'.

To migrate existing Firebase data into Supabase, configure both Firebase and Supabase environment variables and run:

bun run migrate:firebase-to-supabase

The migration is idempotent and overwrites the destination rows for a guild so you can rerun it safely.