Laernos/Husky

Husky Bot is a Discord bot that is designed to help manage your Discord server. It includes a wide range of features, including moderation tools, utility commands, and fun commands to keep your server engaged.

✨ Features
📜 Commands
🛠️ Installation
🤝 Contributing
🔒 License

Features

Responsive Module Management

Turn modules on or off with an intuitive toggle system, giving you complete control over your server's functionality.

Cloud-Based Storage with MongoDB

Husky Bot harnesses the power of MongoDB, to ensure smooth management and operation across multiple servers. Each time Husky joins a new Discord server, it cleverly creates a unique database entry. This means every server gets its own dedicated space for bot configurations and data, allowing for highly personalized settings.

As the owner, you have full control over the bot's interactions with various servers. Whenever the bot joins or leaves a server, it automatically sends a notification to the support server. This notification includes essential information like the server owner's name, the total member count of the server, and the server's icon. This feature is designed to keep you well-informed about the bot's presence across different servers, ensuring effective monitoring and management of its activities.

Effortlessly Report Users or Messages

The report module is a context menu, it allows members to access additional options by right-clicking on a member or message in the server.

If members right-click on a member, they will see an option to report them. If they select this option, they will be asked to provide a reason for the report. This report will be sent to the server moderators.

If members right-click on a message, they will see an option to report the message. If they select this option, they will be asked to provide a reason for the report. This report will be sent to the server moderators.

Efficient Bug Reporting

When server owners encounter issues with Husky Bot, they can easily report these through a user-friendly form directly within Discord.

Once a bug report is submitted, the system automatically sends a copy to both the reporter and the bot's support server.

Users can report bugs effortlessly, ensuring quick fixes and stable performance.

Advanced Logging

Gain insights into your server's activity with detailed logs and analytics.

Server Logging Tracks key server-wide events, such as role changes, channel updates, and server settings alterations.		Member Logging Monitors individual member actions like joins, leaves, nickname changes, and role assignments.
Moderation Logging Records all moderation actions, such as kicks, bans, and unbans, providing a clear audit trail for moderators' actions.		Message Logging Keeps a record of message activities, including message edits and deletions, which can be crucial for resolving disputes and monitoring compliance with server rules.
Voice Logging Logs all voice channel activities, such as users joining or leaving voice channels, which can be useful for managing voice chat and resolving any related issues.		Activity Logging Keeps track of user statuses, such as when members start or stop playing games. This allows moderators to see who is active and what games are popular within the community.

Welcome Module

The welcome module is a feature that allows you to customize the greeting message that is sent to new members when they join your server.

The bot will send a banner card to the designated channel every time a new member joins the server. The banner card will include the new member's name and profile picture.

The welcome module is a great way to make new members feel welcomed and included in your server. Have fun greeting your new members!

Fun Games

🔢 Counting Numbers
Welcome to the counting numbers! In this activity, members can participate by counting up in order.

To join the event, simply type a number in the channel. The next person must then type the next number in the sequence, and so on.

Rules:
- Only numbers are allowed (no decimals or negative numbers).
- You must type the next number in the sequence (e.g., if the last number typed was 3, you must type 4).
- Do not type a number that has already been used.
- Do not spam the channel with numbers.

💯 Guessing Numbers
Welcome to guessing the numbers! In this activity, the bot will create a random number between 0 and 100, and users will try to guess the number.

To participate, simply type your guess in the designated channel.

If you try to guess the number 5 times without success, the bot will give you a hint by saying the number is between two specific numbers (e.g., "The number is between 50 and 75").

The first person to guess the correct number wins the event. Have fun guessing!

Commands

General Commands

avatar: Displays the user's avatar.
echo: Repeats the message back to you.
huskies: Information about huskies.
stats: Shows the bot's statistics.

Moderation Commands

ban: Bans a user from the server.
unban: Unbans a user from the server.
kick: Kicks a user from the server.

Fun Commands

rockpaperscissors: Play Rock, Paper, Scissors with the bot.
guess: Guess a number game.
slot: Slot machine game.
roll: Roll a dice.
dropout_chance: Calculates the chance of a hypothetical dropout.

Server Config Commands

prefix: Sets or shows the bot's prefix.
welcome: Configures welcome messages.
logging: Sets up logging features.

Owner Commands

reload: Reloads a bot's command.
resetdb: Resets the database of the guild.

Installation

Installation Steps:

Follow these steps to install and set up Husky:

Clone the Repository:

Open your terminal or command prompt and navigate to the directory where you want to store your bot's code. Then, run the following command to clone the bot's repository:
```
git clone https://github.com/Laernos/Husky.git
```
Navigate to the Bot's Directory:
```
cd Husky
```
Install Python and Dependencies:

Ensure you have Python installed on your system. You can download it from Python's official website. Next, create a virtual environment and activate it (recommended for isolation):
```
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
```
Invite the Bot to Your Discord Server:
- Create a Discord bot on the Discord Developer Portal.
- Copy your bot's token.
- Use the provided invite link template or generate an OAuth2 invite link with the "bot" scope and the necessary permissions. Invite the bot to your server.
MongoDB SETUP

Husky uses MongoDB for data storage. If you don't have a MongoDB account, follow these steps to create one: Create a MongoDB Atlas Account:
- Visit MongoDB Atlas:
  
  Sign up for an account or log in if you already have one.
- Create a Cluster:
  
  Once logged in, create a new cluster by following the provided instructions. Select a cloud provider and region that best suits your needs.
- Set Up Database User:
  
  In your MongoDB Atlas dashboard, navigate to the "Database Access" section. Click "Add New Database User" and create a username and password. Remember these credentials.
- Whitelist Your IP Address:
  
  In the "Network Access" section, click "Add IP Address" and whitelist your current IP address.
- Get Connection String:
  
  In your cluster's dashboard, click "Connect" and choose "Connect Your Application."
  
  Copy the connection string and replace with the database user's password.
  
  Example connection string:
```
mongodb+srv://<username>:<password>@cluster0.mongodb.net/<database-name>?retryWrites=true&w=majority
```

Configure the bot

Create a .env file in the root directory of your Husky bot project and fill it with the following variables:

 DISCORD_API_TOKEN= "YOUR_DISCORD_API_TOKEN_HERE"
 GUILD = "YOUR_GUILD_NAME"
 GUILD_INVITE = "YOUR_GUILD_INVITE_LINK"
 MONGO_TOKEN= "YOUR_MONGO_DB_TOKEN"
 API_KEY= 'YOUR_API_KEY'
 OWNER_ID = "YOUR_OWNER_USER_ID"
 STATUS_PAGE = 'https://huskybot1.statuspage.io/'
 BOT_INVITE_LINK = 'YOUR_BOT_INVITE_LINK'
 BUG_REPORT_CHANNEL_ID = 'YOUR_BUG_REPORT_CHANNEL_ID'
 BOT_STATUS_CHANNEL_ID = "YOUR_STATUS_CHANNEL_ID"
 BOT_ID = 'YOUR_BOT_ID'

Customize and Enjoy

Customize your bot's behavior and commands as needed. Refer to the README and documentation for more details on configuring and using Husky.

That's it! Husky bot should now be installed and ready to use on your server.

Contributing

Contributions are welcomed to Husky! If you have ideas for improvements or want to report issues, please open an issue or submit a pull request.

License

Husky is licensed under the MIT. If you plan to use any part of this source code in your own bot, please include appropriate credit.

Laernos / Husky

Table of Contents