diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index b6bc240..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,128 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -kevintrinh1227@gmail.com. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md index 50444e8..2c825f7 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,65 @@

- +

An all-in-one Minecraft Hypixel stats and moderation bot.

- Visit the Hycord Project Page for more information. + Visit the Hycord Project Page for more information.

-[![808afada7b715665ba13571e12d93d12](https://user-images.githubusercontent.com/48145892/221743994-65274a3b-601b-4193-9b41-4e0851ca8578.gif)](https://hycord.netlify.app) +[![808afada7b715665ba13571e12d93d12](https://user-images.githubusercontent.com/48145892/221743994-65274a3b-601b-4193-9b41-4e0851ca8578.gif)](https://hycord.net) ## Bot Features -| Bot Feature | Command Usage | Aliasses | Description | -| :----------: | :---------:| :---------:| :--------------------------:| -| Link Account | `!verify [Hypixel username]` | `link` `sync` | Validates and syncs your Discord account to your Hypixel account | -| Update Account | `!update` | `N/A` | Update your account info in the server. (Useful if your level went up or you changed your Hypixel username) | -| Display Guild Points | `!guildpoints` | `dp` `dgp` | Display current daily guild points from each guild member | -| Auto Gexp Announcement | `N/A` | `N/A` | Sends an embed message of all guild points earned by every member in a specified channel | -| Bedwars Statistics | `!bwstats [Hypixel username]` | `bws` `bwstat` | View a certain Hypixel player's in-game Bedwars statistics | -| Inactivity | `!inactive` | `mia` | Send a custom Hypixel guild inactivity notice embed message to a specified channel | -| Ticket System | `!tickets` | `t` | Sends a ticket menu message with buttons that allow users to create their own support tickets | -| Announcements | `!announce` | `announcement` `a` | Create a custom embed message and send it to any channel | -| Say | `!say [Message]` | `yell` `s` | Send any message as an embed to current channel | -| Avatar | `!avatar [@mention member]` | `pfp` `av` | Get a certain user's avatar profile picture | -| Bedwars Statistics | `!bwstats [Hypixel username]` | `bws` `bwstat` | View a certain Hypixel player's in-game Bedwars statistics | -| Guild List | `!guildlist` | `gl` | Show a list of all current members within the Hypixel guild | -| Help Command | `!help` | `idk` `h` `aid` | Show all bot commands, aliases, and command usage examples | -| Custom Welcome Message | `N/A` | `N/A` | Sends a customizable welcome message in a specified channel | -| Cycling Bot Status | `N/A` | `N/A` | Rotating bot statuses with placeholders inside | -| Server Information | `!information` | `info` `inform` | Print out a custom information embed message for your server | -| Ping | `!ping` | `lt` | View your bot's current latency connection speed | -| Ban Player | `!ban [@mention member]` | `b` | Ban a player from your server. This punishment will also be logged in a specified channel | -| Kick Player | `!kick @[mention member]` | `k` | Kick a player from your server. This punishment will also be logged in a specified channel | -| Purge Messages | `!purge [integer value]` | `clear` `del` | Clear a specified amount of message in that specific channel | -| Rules | `!rules` | `r` `rule` | Display the discord server rules in a customizable embed message | -| Role Claiming | `!roles` | `sr` | Sends a customizable public roles menu with buttons to select desired roles | -| Unlink Account | `!unverify` | `unlink` | Unlinks your discord account from your in-game Hypixel account | -| User Info | `!whois @[mention member]` | `who` | Displays general information about a certain discord user | -| Verification Stats | `!vstats` | `vs` | Sends your server's verified users report | +| Bot Feature | Command Usage | Aliasses | Description | +| :--------------------: | :---------------------------: | :----------------: | :---------------------------------------------------------------------------------------------------------: | +| Link Account | `!verify [Hypixel username]` | `link` `sync` | Validates and syncs your Discord account to your Hypixel account | +| Update Account | `!update` | `N/A` | Update your account info in the server. (Useful if your level went up or you changed your Hypixel username) | +| Display Guild Points | `!guildpoints` | `dp` `dgp` | Display current daily guild points from each guild member | +| Auto Gexp Announcement | `N/A` | `N/A` | Sends an embed message of all guild points earned by every member in a specified channel | +| Bedwars Statistics | `!bwstats [Hypixel username]` | `bws` `bwstat` | View a certain Hypixel player's in-game Bedwars statistics | +| Inactivity | `!inactive` | `mia` | Send a custom Hypixel guild inactivity notice embed message to a specified channel | +| Ticket System | `!tickets` | `t` | Sends a ticket menu message with buttons that allow users to create their own support tickets | +| Announcements | `!announce` | `announcement` `a` | Create a custom embed message and send it to any channel | +| Say | `!say [Message]` | `yell` `s` | Send any message as an embed to current channel | +| Avatar | `!avatar [@mention member]` | `pfp` `av` | Get a certain user's avatar profile picture | +| Bedwars Statistics | `!bwstats [Hypixel username]` | `bws` `bwstat` | View a certain Hypixel player's in-game Bedwars statistics | +| Guild List | `!guildlist` | `gl` | Show a list of all current members within the Hypixel guild | +| Help Command | `!help` | `idk` `h` `aid` | Show all bot commands, aliases, and command usage examples | +| Custom Welcome Message | `N/A` | `N/A` | Sends a customizable welcome message in a specified channel | +| Cycling Bot Status | `N/A` | `N/A` | Rotating bot statuses with placeholders inside | +| Server Information | `!information` | `info` `inform` | Print out a custom information embed message for your server | +| Ping | `!ping` | `lt` | View your bot's current latency connection speed | +| Ban Player | `!ban [@mention member]` | `b` | Ban a player from your server. This punishment will also be logged in a specified channel | +| Kick Player | `!kick @[mention member]` | `k` | Kick a player from your server. This punishment will also be logged in a specified channel | +| Purge Messages | `!purge [integer value]` | `clear` `del` | Clear a specified amount of message in that specific channel | +| Rules | `!rules` | `r` `rule` | Display the discord server rules in a customizable embed message | +| Role Claiming | `!roles` | `sr` | Sends a customizable public roles menu with buttons to select desired roles | +| Unlink Account | `!unverify` | `unlink` | Unlinks your discord account from your in-game Hypixel account | +| User Info | `!whois @[mention member]` | `who` | Displays general information about a certain discord user | +| Verification Stats | `!vstats` | `vs` | Sends your server's verified users report | +

NOTE: The Hycord setup video may be outdated. Please refer to the guide below for an accurate up-to-date setup guide.

- ## Getting Started ### 📋 Clone the Repository -1) Open the desired directory in the command prompt -2) Clone the repository using the command below - ```sh - git clone https://github.com/KevinTrinh1227/Hycord-Bot.git - ``` +1. Open the desired directory in the command prompt +2. Clone the repository using the command below + + ```sh + git clone https://github.com/KevinTrinh1227/Hycord-Bot.git + ``` ### 🛠 set-up + 1. Obtain a Discord bot token and Hypixel API key ```sh - Administrator bot permissions is recommended to avoid any issues. + Administrator bot permissions is recommended to avoid any issues. ``` ```sh Enable the "Public Bot" module AND all Privileged Gateway Intents (3 total) @@ -69,7 +71,7 @@ DISCORD_BOT_TOKEN= HYPIXEL_API_KEY= ``` - + 3. Install all dependencies ```sh @@ -88,4 +90,4 @@ ```sh !setup - ``` \ No newline at end of file + ``` diff --git a/setup-tutorial.html b/setup-tutorial.html new file mode 100644 index 0000000..0f7bfde --- /dev/null +++ b/setup-tutorial.html @@ -0,0 +1,11 @@ + + + + Tutorial Video + + + +