Hypixel Skyblock Assistant is a Discord bot created for the Hypixel Network, primarily the custom Skyblock gamemode they have created, the bots main focuses is to help guilds on Hypixel manage their Discord server by automatically synchronizing guild ranks, allowing users to verify themselves through the bot, and get stats about themselves or other people for the Skyblock gamemode.
- Verification system to verify their IGNs.
- Hypixel rank assignment(Auto giving MVP++, VIP, etc)
- Commands to track and see stats for skills, slayers, bank, auction house, talismans, & pets.
- Guild and Player leaderboards(Includes individual leaderboards for skills and slayer types).
- Calculators for skills and pet experience.
- Guild linking with the bot, which provides features like:
- Guild XP Leaderbords.
- Automatic guild role assignments.
- Automatic renaming users to their IGNs.
- Defining guild rank requirements through the bot.
- Checking what rank a user should have based on the requirements that have been setup.
- Scanning the entire guild to calculate guild averages, and to see who meets what rank requirements.
- Donation & Splash trackers to see who contribute the most to the guild.
- Broadcasting system to announce messages through the bot.
- Settings command to configure and customize all the features above.
Note: If you're not looking for a Discord bot but still want a weight calculator you can checkout LappySheep/hypixel-skyblock-weight for a different take on the weight calculation.
- Prerequisites
- Installing Hypixel Skyblock Assistant
- Installing Guild Report Web UI
- Using a custom Guild Leaderboard
- Configuration
- Third Party Licenses
- License
- Java >= 8
- Gradle >= 4
- MySQL/MariaDB Server
- Git
- NodeJS >= 11
- Yarn >= 1.15
- Git
To get started, clone down the repository using:
git clone https://github.com/Senither/Hypixel-Skyblock-Assistant.git
Next go into the Hypixel-Skyblock-Assistant/app folder to build the project using Gradle.
./gradlew build
If the build ran successfully there should now be a jar file called HypixelSkyblockAssistant.jar inside the app directory of the project, this will be used to run the actual bot, you can now run the bot once to generate the config.json file.
java -jar HypixelSkyblockAssistant.jar
After you're finished editing the config with your personal details, run the bot again, if it starts up without any errors it should now work, and you can invite it to Discord servers.
To get started, clone down the repository using:
git clone https://github.com/Senither/Hypixel-Skyblock-Assistant.git
Next go into the Hypixel-Skyblock-Assistant/web folder and install all the dependencies using Yarn.
yarn
While the dependencies are being installed go to the config file to setup the app URL, the config can be found at web/assets/js/config.js , once that's done and the installation have finished, you can now build the project.
yarn prod
Running the app with prod will build all the assets for a production environment, you can also use dev for a development environment, or watch for setting up a watcher that will re-build the project anytime it sees changes being made to the files.
The guild and player leaderboards are created by the Hypixel Skyblock Leaderboard project, which provides an API for the bot to pull the leaderboard data from, and a way to create and manage the leaderboards while not really affecting the bot itself.
If you're interested in creating your own leaderboards instead of using the public leaderboard API, you can follow the instructions on the Hypixel Skyblock Leaderboard repository to setup the API with a custom list of guilds to track.
The Discord token is used to login into Discords web services, allowing the bot to go online and respond to commands. If you don't already have a Discord bot application setup you can easily create one by going to https://discordapp.com/developers/applications/me, create a new application, give it some name, then click on "Create a Bot User", and you're good to go!
The Hypixel token is used to communicate with Hypixels API, allowing to bot to get player, profile, and guild information for the Skyblock gamemode. If you don't already have a Hypixel API token you can get one by logging into the server using mc.hypixel.net and running /api .
The leaderboard URI is the URI that the leaderboard tracker is hosted at, when a custom URI is provided the bot will instead use that API for all guild and player leaderboards, however if the value is left at null , the bot will default back to using the public leaderboard API.
The database properties are used to connect to the database that the bot should use, the database is required for the bot to function correctly since UUIDs, guild, player, and profile data is cached for long periods of time in the database, as-well as verification so the bot remembers which Discord account is linked with what Minecraft username.
Note The MySQL user must be able to create, delete, and modify tables for the database that is used, since the bot uses a migration system to automatically roll out database changes between updates.
The web servlet sets up a JSON API that runs within the bot itself, the API is used by the web portion of the bot, allowing people to view guild scan reports in an easy to read and understand way.
The app_url property is the link to where the web UI is hosted, so linked for guild scan reports can be generated correctly.
Note: Make sure the port the web servlet is running on is open and accessible by the web UI.
Hypixel Skyblock Assistant relies on the following projects:
The project uses code from avaire/avaire, primarily the chat functionality built for JDA, making messaging easier.
Hypixel Skyblock Assistant is open-sourced software licensed under the GNU General Public License v3.0.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent