Refresh the README and use a local logo #21

Merged
selimaj-dev merged 1 commits from readme-refresh into master 2026-09-26 02:24:34 +00:00
Owner

Summary

  • Logo: now uses logo.png in the repo root, a copy of the 400×400 logo from common. The old raw.github.com URL is dead since the move off GitHub. A relative path into the common submodule can't be displayed by Gitea, so the copy sits next to screenshot.png.
  • Style: section emojis and the --- separators are gone. The only emoji left is the heart in the "Made with ❤️" footer.
  • New content:
    • supported versions: 1.21.4–1.21.11 on Fabric, one build per version
    • the cosmetics (cloaks, including animated ones, and hats) and the 18 built-in mods by name
    • installation: Fabric Loader and Fabric API, then Modrinth or the releases page
    • network use: the Saturn server for cosmetics, and Mojang session sign-in, where the access token never reaches the Saturn server
    • building from source: --recurse-submodules, buildAll, a single version, runClient, Java 21
    • a pointer to VERSION_GUIDE.md and the port script for multi-version changes
  • Kept: the header layout, the About and Contributing wording, the credits and the license.

Emotes aren't listed as a feature: playEmote is currently commented out in the version code.

Testing

  • All links return 200 (Modrinth project, Fabric API, fabricmc.net, releases page). The Planet Minecraft credit link returns 403 to automated requests but is unchanged from before.
  • No --- separators remain.

🤖 Generated with Claude Code

## Summary - **Logo:** now uses `logo.png` in the repo root, a copy of the 400×400 logo from `common`. The old `raw.github.com` URL is dead since the move off GitHub. A relative path into the `common` submodule can't be displayed by Gitea, so the copy sits next to `screenshot.png`. - **Style:** section emojis and the `---` separators are gone. The only emoji left is the heart in the "Made with ❤️" footer. - **New content:** - supported versions: 1.21.4–1.21.11 on Fabric, one build per version - the cosmetics (cloaks, including animated ones, and hats) and the 18 built-in mods by name - installation: Fabric Loader and Fabric API, then Modrinth or the releases page - network use: the Saturn server for cosmetics, and Mojang session sign-in, where the access token never reaches the Saturn server - building from source: `--recurse-submodules`, `buildAll`, a single version, `runClient`, Java 21 - a pointer to `VERSION_GUIDE.md` and the port script for multi-version changes - **Kept:** the header layout, the About and Contributing wording, the credits and the license. Emotes aren't listed as a feature: `playEmote` is currently commented out in the version code. ## Testing - All links return 200 (Modrinth project, Fabric API, fabricmc.net, releases page). The Planet Minecraft credit link returns 403 to automated requests but is unchanged from before. - No `---` separators remain. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
selimaj-dev added 1 commit 2026-09-26 02:24:21 +00:00
Refresh the README and use a local logo
Check / compile (pull_request) Successful in 2m4s
bbe6d02568
- Reference logo.png from the repo instead of the dead raw.github URL
  (the logo lives in the common submodule, which Gitea can't serve from
  a relative path, so a copy sits next to screenshot.png)
- Drop the section emojis and horizontal-rule separators
- Add supported versions, the built-in mods, installation (Modrinth,
  releases), network use (Mojang session sign-in; the access token never
  reaches the Saturn server), building from source with submodules, and
  a pointer to the version guide for multi-version changes

Co-Authored-By: Claude Opus 5.5 <[email protected]>
selimaj-dev merged commit 090e5132b2 into master 2026-09-26 02:24:34 +00:00
selimaj-dev deleted branch readme-refresh 2026-09-26 02:24:40 +00:00
Sign in to join this conversation.