selimaj-devandclaude
25a19d7951
Check / compile (pull_request) Successful in 7m44s
Step 6 of #8. versions/1.21.4/src is gone, so all eight versions (1.21.4 to 1.21.11) build from src/. 1.21.4's differences from 1.21.5 are behind version comments: - The end gateway render layer has no render pipeline before 1.21.5 (ShaderUtils: the pipeline field only exists from 1.21.5, and the layer is a four-way chain). - Hat head rotation, the NativeImageBackedTexture constructor, armor slots (inventory.armor vs getEquippedStack), MatrixStackMixin's Quaternionf, and inside the pre-1.21.6 implementations: prevHeadYaw, GUI lighting, ModelTransformationMode, item depth, setShaderTexture and the blur uniform call. Those are one-line version comments, since the pre-1.21.6 blocks are already inside /* */ on newer versions. 1.21.5's drawItem wrapped its body in a second isEmpty check after already returning early for empty stacks; the redundant check is gone, so 1.21.4 and 1.21.5 share the body. Freelook's zoom-out (FreelookMod.shouldZoomOut in GameRendererMixin) only existed on 1.21.4. It doesn't depend on the Minecraft version, so it's back on every version. With no old copies left, the mc-<v> fallback in settings.gradle.kts and scripts/port.sh are removed, and README and VERSION_GUIDE describe the single layout. Co-Authored-By: Claude Opus 5.5 <[email protected]>
87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
<p align="center">
|
|
<img src="logo.png" alt="Saturn Client Logo" width="150px"/>
|
|
</p>
|
|
|
|
<h1 align="center">Saturn Client</h1>
|
|
|
|
<p align="center">
|
|
<b>A free and open-source Minecraft client.</b><br/>
|
|
Built with performance, customization, and community in mind.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="screenshot.png" alt="Saturn Client Screenshot"/>
|
|
</p>
|
|
|
|
## About
|
|
|
|
Saturn Client is a free, open-source Minecraft client designed to enhance the gameplay experience while staying lightweight and customizable.
|
|
Our goal is to build a clean, optimized client that the community can contribute to and improve together.
|
|
|
|
Saturn runs on Fabric and supports **Minecraft 1.21.4 to 1.21.11**, with one build per version. If something doesn't work on your version, please open an issue.
|
|
|
|
## Features
|
|
|
|
- Free cosmetics that don't require real money: cloaks, including animated ones, and hats
|
|
- 18 built-in mods: Armor Display, Auto Sprint, Clock, Coordinates, Crosshair, Day Counter, FPS Display, Freelook, Fullbright, Health Display, Keystrokes, Nametags, No Fog, Ping Display, Speedometer, Status Effects, TPS Display and Zoom
|
|
- Clean and modern UI with animations
|
|
- Ongoing performance improvements
|
|
- Open-source and community-driven
|
|
|
|
## Installation
|
|
|
|
1. Install [Fabric Loader](https://fabricmc.net/use/) and [Fabric API](https://modrinth.com/mod/fabric-api) for your Minecraft version.
|
|
2. Download the Saturn Client jar for the same version from [Modrinth](https://modrinth.com/mod/saturnclient) or the [releases page](https://git.selimaj.dev/saturnclientmc/saturnclient/releases).
|
|
3. Put it in your `mods` folder.
|
|
|
|
### Network use
|
|
|
|
For cosmetics, Saturn Client connects to the Saturn server (`saturn-server.selimaj.dev`). You're signed in the same way as on an online-mode Minecraft server: your client proves who you are to Mojang's session server, and the Saturn server asks Mojang to confirm it. **Your Minecraft access token is only ever sent to Mojang, never to the Saturn server.**
|
|
|
|
## Building from source
|
|
|
|
The version-independent code lives in the `common` submodule, so clone with submodules:
|
|
|
|
```sh
|
|
git clone --recurse-submodules https://git.selimaj.dev/saturnclientmc/saturnclient.git
|
|
cd saturnclient
|
|
|
|
./gradlew buildAll # every version → build/allJars/
|
|
./gradlew :1.21.11:build # a single version
|
|
./gradlew :1.21.11:runClient # launch a development client
|
|
```
|
|
|
|
Building needs Java 21.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions of all kinds:
|
|
|
|
- Code improvements
|
|
- Bug fixes
|
|
- UI enhancements
|
|
- Cosmetic designs
|
|
- Suggestions and feedback
|
|
|
|
If you're an artist or designer interested in helping with cosmetics or visual assets, we'd love to collaborate.
|
|
|
|
Most features belong in `common`, which every Minecraft version shares. For code that differs between versions, see the [version guide](VERSION_GUIDE.md): it covers how the versions share one copy of the code with Stonecutter, writing version-specific code, and adding a new Minecraft version. Every pull request is compiled for all versions automatically.
|
|
|
|
## Credits
|
|
|
|
- **Cloak Rendering:** `IIpho3nix` & Saturn
|
|
- **Who Am I:** `FokshaWasTaken`
|
|
- **Panorama:**
|
|
https://www.planetminecraft.com/texture-pack/minecraft-cavesand-cliffs-part-ii-main-menu-panorama/
|
|
|
|
If any code or assets belong to you and you would like them removed, please open an issue.
|
|
We aim to properly credit all contributors and respect original creators of their respective art.
|
|
|
|
## License
|
|
|
|
Saturn Client is free and open-source under the **Apache-2.0** license.
|
|
|
|
<p align="center">
|
|
Made with ❤️ by the Saturn Client team
|
|
</p>
|