SkyStats

A discord.js bot written for Skyblock Maniacs to get key metrics of a player in Hypixel Skyblock.

Table of Content

• SkyStats
  • Table of Content
  • Prerequisites
  • Installation & Setup
  • Configuration
  • Roadmap

Prerequisites

• Git
• NodeJS >= 14
• Yarn >= 1.2

Installation & Setup

Firstly clone the repository using:

git clone https://github.com/itsneyoa/skystats.git

Then go into the SkyStats folder:

cd skystats

Install all the dependencies using Yarn:

yarn

While the dependencies are being installed you can copy the configuration file.

cp config.example.json config.json

Configure the config file with all the details:

nano config.json

Finally you can run the program:

node index.js

Configuration

• Discord contains all the keys, tokens, IDs etc
  • Token is the token for the discord bot.
    • If you don't already have a Discord App, you can create a new app, then convert the app to a Discord bot, and then get your Discord bot token on the "Bot" page.
    • The Discord bot needs to have the Server Members intent enabled.
  • apiKey is your hypixel api key
    • If you don't already have one run /api new ingame
  • prefix is the prefix the bot will respond to
  • ownerId is the discord ID of the bot owner
    • This gives permission to reload all commands
• Requirements contains the levels required for any requirements you want to check
  • Dungeons catacombs level for carrier roles
  • Skills respective skill level required for skill based roles

Roadmap

• Setup MongoDB for unique stuff in every guild:
  • Prefix
  • Rank requirements
  • Guild requirements
• Add the rest of the metrics for player
  • This requires the normal Hypixel API instead of the facade
• Add verification / name updating
  • Likewise, this requires the normal Hypixel API instead of the facade
• Add metrics other than player
  • Skills
  • Dungeons
  • Slayer
• Add rep system
  • Gives new roles at certain 'rep' milestones
  • Adds suffix to name based on rep score (maybe)
• Add party creator system
  • Command to open a party with set max size
  • People react with ✔ or ✘
  • After party is full or an amount of time has passed the party is closed and leader is sent a list of people to invite by DMs
  • Possibly make it automatically split the members into invite command to send to the leader