Categorygithub.com/Amund211/flashlight
modulepackage
0.0.0-20241228225314-1247b032450f
Repository: https://github.com/amund211/flashlight.git
Documentation: pkg.go.dev

# README

Flashlight

Description

Flashlight is a proxy to the Hypixel API (not associated) built as the backend for the prism overlay. Prism is an open source stats overlay for Hypixel Bedwars.

Flashlight is a Google Cloud function. The version of flashlight hosted by me on Google Cloud is solely intended to be the backend for prism and does not support third party traffic, which is required by the Hypixel API ToS. Flashlight the software project, however, is permissively licensed, and contributions, changes, use, and re-use are encouraged!

Running flashlight locally

Note: make sure you have a recent version of go installed.

Clone the repository

git clone https://github.com/Amund211/flashlight
cd flashlight

Add your Hypixel API key

echo 'export HYPIXEL_API_KEY=<your-key-here>' > cmd/.env

Run flashlight

./cmd/run.sh

Test it

curl 'localhost:8123/v1/playerdata?uuid=<some-uuid>'

Creator info

IGN: Skydeath
UUID: a937646b-f115-44c3-8dbf-9ae4a65669a0

# Packages

No description provided by the author