selimaj-devandclaude
46c7bacd04
Check / compile (pull_request) Successful in 16m19s
Adds 26.3 as a Stonecutter version, the last step of #39. Input: 26.3 replaces GLFW with SDL, which numbers keys (scancodes), modifiers and mouse buttons differently. Saturn keeps GLFW's numbers, which common uses and the config's keybinds store, so saved keybinds stay valid. The new Keys class converts at the boundary: key events, modifiers and mouse buttons coming into Saturn's screens, and key codes going to InputConstants. Its table pairs GLFW's codes with 26.3's InputConstants of the same name. Key names come from the game on 26.3, and version-specific code uses InputConstants' key constants rather than GLFW's. Rendering: Blaze3D's API moved to renderpearl, which Stonecutter replacements cover. PoseStack's quaternion mulPose became rotate, and TextureTarget takes a depth format instead of a flag. 26.3 compiles shaders through SPIR-V and reorders the transforms block, so glass.fsh takes explicit locations and the new order behind defines that GlassRenderer sets, and the unlit cosmetics pipeline declares its color target, which 26.3 requires. OptionsScreen no longer takes whether a world is open. Co-Authored-By: Claude Opus 5.5 <[email protected]>
87 lines
3.7 KiB
Markdown
87 lines
3.7 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 and 26.1 to 26.3**, with one build per version (the 26.1 build also runs on 26.1.1 and 26.1.2). 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. The 26.x versions compile with Java 25, which Gradle downloads when it isn't installed.
|
|
|
|
## 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>
|