DiscordTS-Tags-Bot

A similar project to TFAGaming/Tags-System-Discord-Bot, but has many features, bug fixes, and written in TypeScript.

This project is made for programming servers where the server members helps each other by using tags. They can create a tag easily by using the command /tag create and view it by /tag view.

Table of Contents

• DiscordTS-Tags-Bot
• Table of Contents
• Preview
  • /tag create
  • /tag view
  • /tag list
  • /tag my-tags
  • /tag delete
• Installation
  • Requirements
    • Optional
  • Start up your project
• FAQs

Features

• Simple & easy to understand.
• Max tags per guild members.
• Non-multiguild bot (cannot be a public bot).
• Tags visibility: Public, Unlisted, and Private.
• Using MongoDB as tags Database, and JSON as a configuration Database file.
• Powerful.

Preview

/tag create

Creates a new tag on the MongoDB Database, and saves the content of the message.

/tag view

Replies with the tag content, date of creation, the author, and it's visibility.

/tag list

Replies with a Buttons paginator filled with public tags.

/tag my-tags

Replies with a Buttons paginator filled with public, private, and unlisted tags that you have created.

/tag delete

Deletes a tag that you have created in the Database.

Installation

Requirements

• Software
  • Node.js version ^16.9.0: Click to download
• Libraries
  • discord.js version ^14.9.0: npm install discord.js@14
  • utilityxtreme version ^latest: npm install utilityxtreme
  • mongoose version ^latest: npm install mongoose
  • simple-json-db version ^latest: npm install simple-json-db
  • dotenv version ^latest: npm install dotenv

Optional

• Software
  • Visual Studio Code version ^latest: Click to download

Start up your project

1. Install TSC (TypeScript Compiler) from npm globally:

npm install -g tsc

2. Create a new npm project and then install the required dependencies:

npm init -y
npm install discord.js@14 utilityxtreme mongoose simple-json-db dotenv

3. Rename .env.example to .env and then fill all the required keys' values in that file.

4. Compile the TypeScript files into JavaScript files:

npm run build

FAQs

What's the difference between /tag list and /tag my-tags?

The both commands are having the same job, showing all the tags that are in the Database but each one is having a custom filter. The first command (/tag list) shows only public tags, including yours. The second command (/tag my-tags) shows the tags that you have created, including private, unlisted, and public tags.

What is a tag visibility?

The tag visibility is having three types: Public, which can be viewed by everyone. Unlisted, which can be viewed by everyone, but not listed in /tag list. Private, which can be viewed by the author in DMs. It is similar to YouTube, but not 100%.