Skip to content
This repository was archived by the owner on Nov 13, 2022. It is now read-only.

shuxbot/shuxbot

Repository files navigation

SHUXBOT

Shux Team Discord Bot

Shux Team Discord Server

Firebase admin Prettier Discord.js

Social (Shux Team)

Twitter
Youtube
Instagram

About

Shuxbot is a moderation bot with leveling and tickets system, made to accomplish the main necessities of Shux Team's Discord server.

  • Written in TypeScript using Node.js
  • Currently hosted on Heroku

Features

Moderation
  • Basic commands as kick, ban, mute and blacklist
  • Flood
  • Discord invite links
  • Log reports in a custom channel
  • Custom channel for commands
    • If set normal users will only be able to run commands in that channel
Privilege level for commands usage
  • Levels: user (4), tech (3), mod (2), admin (1), dev (0)

  • Add your own commands

    • Add a new file with the command as name and the extension .ts
    • Basic command structure:
    import { Message } from "discord.js";
    
    exports.run = (msg: Message, args: string[]) => {
      /* here goes your code */
    };
Tickets system (reaction and command)
Reaction roles
Leveling

Installation

  • Clone this repository
    $ git clone https://github.com/afriguez/shuxbot.git

  • Change directory
    $ cd shuxbot/

  • Install dependencies
    $ npm install

  • Environment
    Shuxbot uses 3 main .env variables

    TOKEN=YOUR_BOT_TOKEN
    GUILD=THE_GUILD_ID
    DB_URL=https://YOUR_FIREBASE_DATABASE.firebaseio.com
    

    Then you'll need the service account provided by Firebase
    $ cp path/to/your/yourServiceAccount.json shuxbot/serviceAccount.json

Once installed use $ npm run build to transpile and $ npm start to run the bot

LICENSE

This repository is under the MIT license. Read it here

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •