IMS Bot

A Custom Discord Bot made for the IMS Discord Server
Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

IMS Bot is a customized Discord Bot made to accomplish all the automation needs of the IMS Discord Server. Here are some of it's key features:

• Automatic message flagging using the OpenAI moderation API
• Guild application creation and management
• Punishment system with automatic logging
• Guild blacklist system integrated with guild applications and verification
• Sync Discord roles with in-game statistics and guild information
• Verify members and flag suspicious new joins
• Automatically update member count channels

This Discord bot is in ongoing development, and its features will change as the needs of IMS change over time.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a copy of the bot up and running follow these example steps:

DISCLAIMER: Many channels/roles are hardcoded in /src/bot/constants.js. The bot will not work unless these are changed to ones valid for your server. The bot was made specifically for IMS.

Prerequisites

In order to run the bot, you need the following:

• npm

  npm install npm@latest -g

• A MySQL Database (I use this)
• A Discord Bot (create one here)
• A Hypixel API Key (get one here)

Installation

Assuming you have all the prerequisites, follow these steps to get the bot up and running.

1. Clone the repo

   git clone https://github.com/Charliehyin/IMSBot.git

2. Install NPM packages

   npm install

3. Create a .env file in the root directory, and fill it in

   DISCORD_TOKEN=<Token for the Discord bot>
   DB_HOST=<Link where database is hosted>
   DB_USER=<Username for database>
   DB_PASSWORD=<Password to the database>
   DB_NAME=<Name of the database>
   MODERATION_API_KEY=<Your OpenAI API key>
   HYPIXEL_API_KEY=<Your Hypixel API key>

4. Start the bot

   npm start

(back to top)

Usage

Join IMS to see the bot in action.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Charlie Yin - Email, LinkedIn Discord Username: realnitril

(back to top)