Skip to content

A Discord Bot written in TypeScript using custom classes with advanced Features

License

Notifications You must be signed in to change notification settings

CuteNikki/discord-bot

Repository files navigation

- A WORK IN PROGRESS -

DiscordJS Bot written in TypeScript

This discord bot was built with custom classes, i18next for translations, Discord Player for music, Pino as logger and MongoDB as database.


Discord.JS version 14 Repository Stars Repository Forks MIT License Repository Issues
Made with 💖 by Nikki

How to Install and Run the Project

All it takes is just 8 simple steps.

# 1. Clone repository
git clone https://github.com/CuteNikki/discord-bot.git

# 2. Navigate into folder:
cd discord-bot

# 3. Install dependencies:
npm install

# 4. Setup your config:
#    Rename example.config.json to config.json
#    Fill in each field (for more details read config).

# 6. Install ffmpeg:
#    It is recommended to install it from the official source.
#    https://ffmpeg.org/download.html
#    Do not recommend installing ffmpeg via npm
#    because binaries pulled from npm are known to be unstable!

# 7. Deploy slash commands:
npm run deploy
#    can also use the /register command on discord
#    after the commands have been registered once.

# 8. Run the bot:
npm run start

TO-DO

  • Level Module
    • Weekly levels
    • Rank command (with weekly option)
    • Leaderboard command (with weekly option)
    • Config command
      • Modify users level/XP
      • Levelup announcement
        • Can be sent to current/other channel or dms
      • Ignored roles (Users with role will not receive any XP)
      • Ignored channels (Messages in channel will not give any XP)
      • Enabled channels (When set will only enable level module in those channels)
  • Moderation Module
    • Ban/Tempban command
    • Unban command
    • Kick command
    • Timeout command
    • Warn command
    • Infractions command
    • Config command
  • Utility Module (Planning on adding more)
    • Avatar/Banner command
    • Userinfo command
    • Serverinfo command
    • Weather command
    • Math command
    • Config command
  • Music Module
    • Config command
  • Log Module
    • Config command
  • Welcomer Module
    • Config command
  • Custom VC Module
    • Config command
  • Economy Module
    • Config command
  • Fun Module
    • Config command
  • Ticket Module
    • Config command

Contributing

Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.


Show your support

Please ⭐️ this repository if this project helped you!


License

Copyright © 2024 CuteNikki. This project is MIT licensed.


About

A Discord Bot written in TypeScript using custom classes with advanced Features

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published