Solar Stats 📊

Minecraft proxy server for Hypixel. It's like a stats overlay, but better. This program will be integrated in Solar Tweaks V4. For now you can build it by yourself and enjoy it before a release. And as a lot of our projects, this one is also open source!

⚠️ But this version may have bugs!

Downloading ⬇️

For now you must build it yourself.

Usage ⚒️

To use it you need to have NodeJS installed. (LTS version is recommended)

Configuration ⚙️

At the root of the project (or in the same directory as the executable) create a config.json file with the following content: (You can also find the content of this file in the config.example.jsonc file)

{
  "apiKey": "", // Your Hypixel API key (`/api` in game)
  "heightLimitDelayFix": true, // Makes the delay before a block is removed when above the height ultra fast,
  "bedwarsWaypoints": true, // Enable waypoints for Bedwars
  "lunarCooldowns": true, // Enable Lunar cooldown mod (arrow in bridge for example)
  "bedwarsTeammates": true, // Make the TeamView mod work for Bedwars
  "server": {
    // Server to connect to
    "host": "hypixel.net", // IP of the server
    "port": 25565 // Port of the server
  }
}

Starting the server 🚀

Make sure to have built the server before starting it.

With NodeJS

$ npm run start

With the executable

Just execute the executable file. For non windows operating system you can use

$ .\path\to\executable

Building from source 🏗️

Clone the repository on your machine using

$ git clone https://github.com/Solar-Tweaks/SolarStats

Once the repo is downloaded move to the directory and install the dependencies

$ cd SolarStats
$ npm install

You can build the project (but you will need to use npm run start to start it)

$ npm run build

Or you can package to an executable with

$ npm run package

Authenticating 🔒

When you will login for the first time you will see in the console a message like this:

[msa] First time signing in. Please authenticate now:
To sign in, use a web browser to open the page https://www.microsoft.com/link and enter the code XXXXXXXX to authenticate.

Open a browser and login with your Microsoft account. If you have not migrated your account yet you can try to edit the code manually. (Or migrate your account)

matiaspor / SolarStats