Skip to content

Halocrea/invite-finder

Repository files navigation

Welcome to invite-finder 👋

Version Twitter: HaloCreation

A bot that will tell the administrators and moderators where does a new member come from

About

This bot is here to tell you which invite has been used by a newcomer on your server.
Basically, you only need to set the channel where you want the bot to post information about a newcomer on your server and the bot will handle the rest on his own. Here is all the information you will get from him.

newcomer information

Setup

  • If you never set up a Discord bot before, please follow the instructions over here.
  • If you don't want to host your own version of the bot but consume an existing instance of it, you can use the following invite link: https://discord.com/api/oauth2/authorize?client_id=765327990896197642&permissions=85024&scope=bot
  • Once that is done, invite the bot to your server. The bot will automatically add your server inside his database. The only thing you need to do is to run !gm-set-logs-channel where you want him to send messages, so basically the channel where you store logs.

Commands

Notice: You must be an Administrator of your server or the maintainer of the bot instance to run these commands.

  • !gm-set-logs-channel: Use this command to tell the bot to post his messages inside the channel where you run this command
  • !gm-invites-sync: Use this command to synchronize the invites of your server with the ones in the bot database. But everything is synchronize automatically right now so you basically won't need to run it

Permissions required

In order to work properly, this bot will need this set of permissions globally:

  • Manage Server
  • View Channels
  • Send Messages
  • Embed Links
  • Read Message History

Install

Create .env file and fill it with your information

cp sample.env .env

Install and run with Docker

docker build -t invite-finder .
docker run -d -v /absolute/host/path/to/saves/:app/saves --restart=always --name=invite-finder invite-finder

Install with npm

Setup

npm install

Run development

npm run dev

Build

npm run build

Run build

npm start

Author

👤 Grenadator

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator

About

A bot that will tell the administrators and moderators where does a new member come from

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published