- Notifications
You must be signed in to change notification settings - Fork0
🏷️ Tags allows for servers to answer the most frequent questions easier
License
buape/Tags
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Buape Tags is a simple Discord bot that allows you to save custom text snippets and use them for later. It's a great way to save time and effort when you're typing out the same thing over and over again.
Some of the use cases Tags might serve are:
- A bot support server where users ask the same questions often,
- A server with frequent live moderation where rules may need to be quoted often,
- A development server where you may need to share code snippets often,
- Or even just a server where you want to share a funny meme or quote often
| Command | Arguments | Description |
|---|---|---|
| /create-tag | private: true/false | Opens a modal where the user is asked for the tag trigger and tag content. |
| /send-tag | tag: auto-populates, user: auto-populates, private: true/false | Replies to the command with the tag content, with an optional user to mention. |
| /edit-tag | tag: auto-populates, private: true/false | Opens a modal where the user is asked for the new tag trigger and/or content. |
| /delete-tag | tag: auto-populates, private: true/false | Deletes the tag. |
| /list-tags | private: true/false | Lists all tags in the server and their usage count, author, last editor, etc. |
- Move away from a HTTP based bot to a gateway based bot
- Web dashboard to allow for a much better user experience
- Setup repository with Buape standards for maintenance
- Role, channel lock tags
- Log actions
Right now the bot is pretty simple to setup and run. You'll need to have the following:
- A non-ancient version of Node.js
- pnpm installed globally
- A Discord bot application
- A CockroachDB database
- Clone the repository
git clone https://github.com/Buape/Tags.git - Run
pnpm install - Create a
.envfile in the root of the project based on.env.example, allDISCORD_variables can be found in the Discord Developer Portal, theDATABASE_URLvariable can be found in the CockroachDB Console,COMMANDS_DEBUGandDEVELOPMENT_GUILD_IDaren't required but are useful for development,PORTcan remain as it is, if you know you need to change it, you probably know how to change it. - Run
pnpm run build - Run
pnpm run db:push - Run
pnpm run sync - Run
pnpm run start
For the sake of transparency, thepublic version of Tags is hosted onDokploy running on aHetzner VPS but you can host it anywhere you want.
The main thing to keep in mind is that once your application is hosted on a public URL, you'll need to add it to theInteractions Endpoint URL in the Discord Developer Portal.
This project is licensed under theMIT License.
No additional permissions are required for the bot to run, other than the base Send Messages permission.
If you have any questions, or similarly if you find any issues with the bot, feel free tocreate an issue or join theBuape Discord Server.