Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

EvieHarv/HypixelStats

Repository files navigation

HypixelStats

HypixelStats is a cross-platform, open-source project that aims to be the easiest way to get stats about the players in your games.

Works for more than just bedwars! You can define exactly what you want to see and how you want to see it, making it the most configurable option out there!

Not associated with Hypixel Inc.

Watch the Getting Started Video!

Join the Discord!

Main Page

Overlay Bedwars

Overlay Duels

Features

  • Automatically detects when you join new game, sends /who to get the full list, and automatically detects when players leave/join and adds/removes them from the list.
    • Auto /who should work fine with nothing else on windows, other platforms require Java to be installed in the PATH.
  • Fully configuarable view of stats, with on-the-fly profile switching (with keybinds!) for easy viewing of any stats you want, at any time.
    • Also includes assignable colors based off of stats, as well as the ability to sort the list by any (numeric) stat.
  • An overlay for easy stat-viewing.
  • Connects to a sniper network, courtesy of bwstats! discord.gg/bwstats. (This is run through a json wrapper, and can be found at api.hypixelstats.com/sniper)
    • Shows snipers and reported players.
  • Includes the ability to whitelist/blacklist players for quick identification. By default, whitelisted players appear green and blacklisted players appear red. (This is configurable in the profiles!)
  • Detects nicked players and displays them as yellow by default (also configurable).
  • Keeps track of every player you've run into since you opened the app (single-session), for ease of blacklisting or whitelisting players you've recently played with.
  • Built-in plancke.io search

Features in the works

  • A lobby mode
  • Easier profile management system
  • More robust default profiles

Installing, Getting Set Up, and Updating

Installing

  • Go to the latest release (on the right side of this page).
  • If you're on windows, download HypixelStats.exe and run it.
    • Your antivirus will probably throw a fit. It's fine, just ignore the warnings and continue. You can look at and compile the code yourself if you don't trust me (hey, I get it).
    • Complete the installer.
    • The installer should automatically create a Desktop Icon. You can run the program from there.
  • If you're on linux, use the .AppImage and you're done.
  • If you're on MAC, reference the Building article.

Setup

  1. To get started, get your hypixel key. You can do this just by joining hypixel and doing /api key. Then, go to Settings -> Application Settings, and put it in.

    • Any time you switch to an alt account, make sure to do /api new and it will automatically detect it and set it for you. (You don't even have to be on the Settings page! It'll pick it up anywhere). It can break things if you don't do this.
  2. You will also need to set your log path. You can just click your client in Application Settings. If you use a custom logfile path, you can set that here too.

Done!

You can now join a game and see all the stats!

NOTE: If you ever play nicked, make sure to go to the Aliases tab and set your nickname! It'll automatically change your name in the tool so you can see your stats (i.e. winstreak) update.

Updates

When a new update is available (Windows + Linux, MAC users reference Building), you'll see a prompt in the top right of the dashboard to update. Click it, and you're done! It's that easy.