https://github.com/tobitenno/quickmute

A simple quick mute bot written in node.js
https://github.com/tobitenno/quickmute

bot discordjs discordjsbot nodejs opensource

Last synced: 2 months ago
JSON representation

A simple quick mute bot written in node.js

• Host: GitHub
• URL: https://github.com/tobitenno/quickmute
• Owner: TobiTenno
• License: mit
• Created: 2017-12-07T19:08:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-10-10T02:34:10.000Z (over 2 years ago)
• Last Synced: 2025-03-11T09:53:26.835Z (over 1 year ago)
• Topics: bot, discordjs, discordjsbot, nodejs, opensource
• Language: JavaScript
• Size: 864 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# QuickMute

A simple quick mute bot written in node.js

![QuickMute](https://raw.githubusercontent.com/TobiTenno/QuickMute/master/images/logotype_color.png "QuickMute is a handy bot")

## Deploy your own

In the interest of making this easier for you, I've set up an app.json and heroku deploy button (below).

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/tobitenno/quickmute)

## Getting Started

1. Install node.js version 8 or higher, I prefer the LTS release.

2. Clone this repo (`git clone https://github.com/TobiTenno/QuickMute.git`)

3. Navigate to the new directory (`cd QuickMute`)

4. Install dependencies (`npm i`)

5. Use pm2 or your choice of process managers to set environment variables.

Example:

```json

{

  "apps": [

    {

      "name": "quickmute",

      "script": "index.js",

      "exec_interpreter" : "node",

      "watch"            : ["pm2.json"],

      "log_date_format"  : "YYYY-MM-DD HH:mm Z",

      "env": {

      	"TOKEN": "",

        "PREFIX": "!",

        "OP_ROLE": "",

        "LOG_CHANNEL": "",

        "GUILD_ID": ""

      }

    }

  ]

}

```

6. (Optional) Start bot with pm2 (`pm2 start pm2.json`).

7. (Optional) Fork and deploy to heroku (Procfile included)

## Contributing

If you find bugs, let me know, make an issue, and if you know the fix, submit a PR. All for the betterment of all of us!

## Future Features

Probably not many. I built this to be pretty simple and straightforward.

I might make the image ones dynamic and pull from Environment vars so you don't have to modify any source to use this.