Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 2.89 KB

README.md

File metadata and controls

54 lines (38 loc) · 2.89 KB

SkyCrypt 🍣

A Hypixel Skyblock Profile Viewer

The SkyCrypt Project, which is based on LeaPhant's skyblock-stats, allows you to share your Hypixel SkyBlock profile with other players with a quick overview of your Stats, Skills, Armor, Weapons and Accessories.

Website: https://sky.shiiyu.moe

CI/CD

Screenshot

Screenshot

Contributing

You are free to report bugs or contribute to this project. Just open Issues or Pull Requests and the Developer team will look into them.

Prerequisites

Installation

A more explanatory guide can be found in CONTRIBUTING.md

Clone the project and run pnpm i to install the dependencies.

Now open credentials.json and enter a valid Hypixel API Key. You can obtain one by going to developer.hypixel.net/dashboard and clicking Create API Key.

mongod needs to be running as a service in the background and the redis-server needs to be started.

You can now run pnpm start to start it. You will be able to access the site on http://localhost:32464 if you leave the default port.

Credits