Early development · Minecraft 26.3

Spoutcraft, remade
for modern Minecraft.

A Purpur-based server and a Fabric client mod that let servers push custom GUIs, HUDs, skies, sounds and keybinds to players. Players without the mod can still join.
$ 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. Each feature has a vanilla fallback, so a server never has to choose between the two.
Client mod
Custom GUIs and HUD
Server-driven screens with buttons, text fields and sliders, plus HUD widgets that can hide or move the vanilla bars. Popups fall back to vanilla dialogs.
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
Sound events delivered through a generated server resource pack, with optional HTTPS streaming that each server has to opt into.
Client mod
Server keybinds
Plugins register key bindings that appear under a Server category in the controls menu. Presses arrive as events, only for keys the server declared.
Works on vanilla
Waypoints
Locator bar waypoints for every player, with in-world beacons and Xaero's and JourneyMap integration for modded clients.
Client mod
Capes and nameplates
Server-provided cape textures and multi-line coloured name titles, with text displays as the fallback for vanilla clients.
Works on vanilla
Movement
Gravity, walk, swim and jump multipliers built on vanilla attributes, so they apply to every player on the server.
Works on vanilla
Notifications
Native toasts for modded clients, falling back to an advancement toast or an action bar message for everyone else.
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. Neither piece locks out players who skip the other.
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.
Vanilla clients welcome
Players without the mod join as normal. Every feature declares what they see instead, such as a dialog, a resource pack, or nothing.
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")
}

dependencies {
    compileOnly("org.spoutcraftredux:spoutcraftredux-api:26.3-R0.1-SNAPSHOT")
}
Roadmap

Where the project stands.

SpoutCraft Redux is in early development. Each phase ends in a working demo and automated tests.
  1. Phase 0

    Skeleton In progress

    Server fork, Fabric client, shared protocol and the join handshake.

  2. Phase 1

    Vanilla parity

    Movement, text displays, particles, sounds, toasts and server keybinds.

  3. Phase 2

    Widgets and HUD

    The widget toolkit, popup screens, HUD overlays and dialog fallbacks.

  4. Phase 3

    Environment and appearance

    Sky and fog, generated resource packs, custom sounds, capes and nameplates.

  5. Phase 4

    Items and API polish

    Custom items over data components, recipes, Javadoc and a first API freeze.

  6. Phase 5

    Custom blocks

    Block mapping onto vanilla states first, then a decision on deeper client support.

  7. Phase 6

    Breadth

    NeoForge, Minecraft 26.4, minimap integrations and wider release channels.

Follow along from the first build.

Server and client builds appear on the downloads page as soon as they are published. Expect rough edges while the project is in early development.