Skip to content

A discord bot that mute/unmute all users in a voice channel using Discord-JS lib.

Notifications You must be signed in to change notification settings

brunopeternella/MuteX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MuteX

This is a project that I initially have an ideia to mute/unmute all members in a channel automatically to play Among Us with my friends! xD


πŸ’­ How can I add MuteX to my server?

Click on me!

πŸš€ Self-hosting

You can host MuteX instance in your local machine! But you'll need some experience to do that and it's for users that want to learn or help the project! 😁

πŸ“¦ Prerequisites

Before starting, make sure you've met the following requirements:

  • Create an App on Discord Developers here!
  • Node.Js
  • Ngrok Account
  • Ngrok.exe Downloaded
  • (Optional) Enable Developer Mode on Discord: User Settings -> Advanced -> Developer Mode

Obs.: The Developer Mode option will allow you to get IDs from users, text channels, voice channels, server, etc. It'll only help you on development and isn't mandatory.

πŸ’» Installing MuteX:

  • Clone the repository
git clone https://github.com/brunopeternella/MuteX.git
  • Go to the repository
cd MuteX
  • Install node dependencies
npm install

βš™οΈ Configuring .env

All that information is found in your app settings.

  • CLIENT_ID - It's your... literally... Client ID...
  • TOKEN - It's your Client Secret

βš™οΈ Configuring Ngrok

  • Open ngrok.exe
  • Run the command bellow
ngrok.exe http 80

This will start a connection that camouflage your localhost with a random-generated valid address.

When you access that address, it'll redirect to your localhost:80

This is necessary because Discord needs to comunicate with a host.

In other words, what server Discord will call when someone uses your bot commands? It can't be your locahost, literally. But with ngrok, that valid address will redirect without any problems and will work! =D

β˜• Running MuteX

There are two commands that you can use:

  • Start MuteX without Nodemon
npm start
  • Start MuteX with Nodemon
npm run dev

If you're developing, use with Nodemon, it'll auto reload the app when you change anything on the code.
Otherwise, if you'll let the app runing for sometime, use without Nodemon.

About

A discord bot that mute/unmute all users in a voice channel using Discord-JS lib.

Topics

Resources

Stars

Watchers

Forks

Languages