For Minecraft 26.3
Spoutcraft, remade
for modern Minecraft.
A Purpur-based server and a Fabric client mod that let servers push custom GUIs, HUDs, notifications, sounds and key bindings to players.
$ java -jar spoutcraftredux-paperclip-26.3.jar --nogui
→ Paper → Purpur → SpoutCraft Redux
→ Listening on *:25565 ✓
> spoutcraftredux list
→ Steve SpoutCraft Redux client
→ Alex vanilla client
Features
What the client mod unlocks.
The classic Spoutcraft feature set, rebuilt on modern Minecraft. Players without the client can still join, and the server points them to the download.
Client mod
Custom GUIs and HUD
Server-driven screens with buttons, text fields, sliders, lists and images, plus HUD widgets drawn over the game.
Client mod
Sky and environment
Sky, fog and cloud colours, cloud height, stars, and the size and texture of the sun and moon, set per player and reset on disconnect.
Works on vanilla
Custom sounds and resource packs
Plugins ship sounds, models and textures in a resource pack that the server merges and sends to every player on join.
Client mod
Server key bindings
Plugins register key bindings that players see and rebind under Custom Bindings in the Controls screen. Presses arrive as events, only for keys the server declared.
Later
Waypoints
In-world waypoints for players with the client, with Xaero's and JourneyMap integration.
Later
Capes and nameplates
Server-provided cape textures and multi-line coloured name titles.
Works on vanilla
Movement
Gravity, walking and jumping multipliers built on vanilla attributes, so they apply to every player on the server.
Client mod
Notifications
A popup that slides in at the top right with a title, a message and an item icon.
Later
Custom blocks
Server-defined blocks are the hardest part and come last, starting with a mapping onto spare vanilla block states.
Platform
A server, a mod, and room for everyone.
SpoutCraft Redux is two pieces that talk over a versioned handshake.
Purpur-based server
A fork in the Paper → Purpur → SpoutCraft Redux chain, shipped as a single paperclip jar. Paper and Purpur plugins keep working.
Fabric client mod
A Fabric mod for Minecraft 26.3 that announces its capabilities when joining. NeoForge support is planned.
Players without the client
They can still join. Client features do nothing for them, and the server sends a chat message with a link to download the client.
Plugin API
Plugins compile against spoutcraftredux-api, check whether a player has the client, and use the features it supports.
Data, not code
The client never runs code sent by a server. Screens, widgets, skies and assets all arrive as data.
Open source
Licensed under LGPL-3.0. The server includes Paper and Purpur code, so it is distributed under GPL-3.0 like its upstreams.
For plugin developers
Write plugins against the API.
The API is published to the SpoutCraft Redux Maven repository. Add it as a compileOnly dependency, since the server provides it at runtime. Only snapshots exist for now, and the API will change before the first stable release.
build.gradle.kts
repositories {
maven("https://repo.spoutcraftredux.org/snapshots")
maven("https://repo.papermc.io/repository/maven-public/")
}
dependencies {
compileOnly("org.spoutcraftredux:spoutcraftredux-api:26.3.build.+")
}
Follow along from the first build.
Server and client builds appear on the downloads page as soon as they are published.