selimaj-devandclaude
95e4dff448
Check / compile (pull_request) Successful in 7m13s
Step 2 of #8. versions/1.21.10/src is gone; 1.21.10 builds from src/ as :1.21.10, with versions/1.21.10 keeping only gradle.properties and run/. API differences go behind version comments: render layers (ShaderUtils), Camera.update's World vs BlockView (CameraMixin), the text and textured-quad render states (RenderScopeImpl), Screen.init (SplashOverlayMixin) and jspecify's @NonNull (SaturnRenderState). Features 1.21.11 leaves out stay on 1.21.10, with a TODO for 1.21.11: WorldFeatureImpl.getWorldAge, SaturnScreenFabric.resize and EntityDrawerImpl clearing the hitbox. Hats now render on 1.21.10: its HatFeatureRenderer overrode the render-queue method with an empty body, and the working code sat in an old VertexConsumerProvider method nothing called. 1.21.10 now uses 1.21.11's render-queue implementation (HatFeatureRenderer, ObjModel, ObjRenderer), and also gets 1.21.11's null check on the player's display name. The 1.21.10 jar has the same entries, fabric.mod.json and mixin configs as before; only those four classes and ShaderUtils (a helper method for entityAlpha) have different bytecode. The 1.21.11 jar only differs in ShaderUtils. Co-Authored-By: Claude Opus 5.5 <[email protected]>
87 lines
3.6 KiB
Markdown
87 lines
3.6 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 (versions not on Stonecutter yet: :mc-1.21.9)
|
|
./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 are laid out, porting a change to all of them with `scripts/port.sh`, 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>
|