Skip to content

README.md

Latest commit

 

History

History
118 lines (83 loc) · 7.59 KB

README.md

File metadata and controls

118 lines (83 loc) · 7.59 KB
Raw

This is a fork of SkyCryptWebsite/SkyCrypt-Frontend with minimal changes to support embedding the profile viewer in Lunar Client. To keep this fork up to date with upstream:

git rebase upstream/dev
# Resolve any conflicts that occur
git push origin dev --force-with-lease

Lunar Client Workers deployment

.github/workflows/deploy-workers.yml runs the existing lint, Svelte/TypeScript, and test checks before building and deploying this fork. dev selects the cloudflare-production GitHub environment; other branches select cloudflare-development and upload a preview version with a branch alias. A missing development Worker is initialized before its first preview upload.

Each GitHub environment must supply the CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN secrets and the CLOUDFLARE_ENV variable (production or development). Restrict cloudflare-production to the dev branch. Account IDs come from those secrets, not Wrangler files. Both accounts use the Worker name skycrypt-embed; production owns skycrypt-embed.lunarclient.com, while development has no custom domain. Both environments retain the existing SkyCrypt API URLs.

Before enabling this workflow, provision the GitHub environments and account credentials, configure any required runtime secrets in the destination accounts, and disable the old Workers Builds integration so it does not deploy alongside GitHub Actions. The destination production account must contain the lunarclient.com zone. Deployments use --no-x-provision and no longer bind the old shared-account observability Tail Worker.

Local validation without deployment:

pnpm install --frozen-lockfile
cp .env.example .env
CLOUDFLARE_ENV=development PUBLIC_API_URL=https://sky.shiiyu.moe/api/ PUBLIC_SERVER_API_URL=https://sky.shiiyu.moe/api/ pnpm build
pnpm exec wrangler deploy --dry-run --no-x-provision --env development
pnpm exec wrangler deploy --dry-run --no-x-provision --env production

SkyCrypt 🍣

A Hypixel Skyblock Profile Viewer

Sponsor   GitHub Repo stars   GitHub Repo stars

A website that provides per-player information about the game Hypixel SkyBlock.

Originally inspired by LeaPhant's skyblock-stats.

This repo is built from the ground up to replace the original SkyCrypt for a more modern and maintainable codebase.

Screenshot

Screenshot

Contributing

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

Refer to the CONTRIBUTING.md file for more information on how to contribute.

Tip

Contributions are not limited to code. Making suggestions, reporting bugs, and sharing the project with others are all forms of contribution that are highly appreciated.

Licensing

SkyCrypt Frontend uses a split license model:

Material License Notes
Source code, documentation, configuration, build scripts, and original non-excepted assets introduced or modified from the June 2026 license-change commit onward GNU AGPLv3 Network use of modified versions must provide users access to the corresponding source code.
Earlier versions and pre-change contributions previously released under MIT MIT Existing MIT grants are preserved and are not revoked by this transition.
SkyCrypt brand/logo asset exception MIT These assets are explicitly listed in NOTICE and static/BRAND_ASSETS_LICENSE.
Third-party libraries, resources, APIs, fonts, and textures Their respective licenses See upstream projects and package metadata for their terms.

The MIT brand assets are:

  • static/apple-touch-icon-precomposed.png
  • static/favicon.ico
  • static/favicon.png
  • static/img/logo.avif
  • static/img/logo_black.avif
  • static/img/newsroom.avif
  • static/img/app-icons/**

Unless a file has a more specific license notice, new contributions to this repository are accepted under GNU AGPLv3.

Credits

Original Site: sky.lea.moe by LeaPhant

Used Resources

Custom Textures:

Background Image:

Tools, Libraries, and APIs: