---
title: "SpoutCraft Redux Docs"
description: "Install the SpoutCraft Redux server and client, write plugins against the SpoutCraft Redux API, and fetch builds from the downloads API."
canonical_url: "https://docs.spoutcraftredux.org"
---
# SpoutCraft Redux Docs

> Install the SpoutCraft Redux server and client, write plugins against the SpoutCraft Redux API, and fetch builds from the downloads API.

::u-page-hero{class="dark:bg-gradient-to-b from-neutral-900 to-neutral-950" orientation="horizontal"}
#top
  :::hero-background
  :::

#headline
  :::u-badge{color="warning" size="lg" variant="subtle"}
  Early development · Phase 0
  :::

#title
Spoutcraft, rebuilt for [Minecraft 26.3]{class="text-primary"}.

#description
SpoutCraft Redux brings back the server-driven GUIs, HUD widgets, skies, sounds and keybinds of the original Spoutcraft. It ships as a Purpur fork for the server and a Fabric mod for the client, and players without the mod can still join.

#links
  :::u-button{size="xl" to="https://docs.spoutcraftredux.org/getting-started" trailing-icon="i-lucide-arrow-right"}
  Get started
  :::

  :::u-button{size="xl" to="https://spoutcraftredux.org/downloads" color="neutral" icon="i-lucide-download" target="_blank" variant="outline"}
  Downloads
  :::

#default
  :::prose-pre
  ---
  code: |
    @EventHandler
    public void onReady(SpoutCraftReduxClientReadyEvent event) {
        SpoutCraftReduxPlayer player = event.getSpoutCraftReduxPlayer();
        getLogger().info(event.getPlayer().getName()
            + " joined with SpoutCraft Redux " + player.modVersion().orElse("?"));
    }
  filename: JoinListener.java
  ---
  ```java [JoinListener.java]
  @EventHandler
  public void onReady(SpoutCraftReduxClientReadyEvent event) {
      SpoutCraftReduxPlayer player = event.getSpoutCraftReduxPlayer();
      getLogger().info(event.getPlayer().getName()
          + " joined with SpoutCraft Redux " + player.modVersion().orElse("?"));
  }
  ```
  :::
::

::u-page-section{class="dark:bg-neutral-950"}
#title
Find your way around

#features
  :::u-page-feature{icon="i-lucide-server" to="https://docs.spoutcraftredux.org/getting-started/installing-the-server"}
  #title
  Run a server

  #description
  Swap your Purpur jar for the SpoutCraft Redux jar. Worlds, plugins and configs carry over.
  :::

  :::u-page-feature{icon="i-lucide-monitor" to="https://docs.spoutcraftredux.org/getting-started/installing-the-client"}
  #title
  Install the client

  #description
  Add the Fabric mod to unlock the extra features on SpoutCraft Redux servers.
  :::

  :::u-page-feature{icon="i-lucide-code" to="https://docs.spoutcraftredux.org/plugin-development"}
  #title
  Write plugins

  #description
  Compile against `spoutcraftredux-api`: the Purpur API plus `org.spoutcraftredux.api`.
  :::

  :::u-page-feature{icon="i-lucide-cloud-download" to="https://docs.spoutcraftredux.org/downloads-api"}
  #title
  Automate downloads

  #description
  Fetch the latest server and client builds from a Purpur-style REST API.
  :::

  :::u-page-feature{icon="i-lucide-users" to="https://docs.spoutcraftredux.org/getting-started#vanilla-players"}
  #title
  Vanilla players welcome

  #description
  Every feature defines what a client without the mod sees, from dialogs to resource packs.
  :::

  :::u-page-feature{icon="i-lucide-git-pull-request" to="https://docs.spoutcraftredux.org/contributing"}
  #title
  Contribute

  #description
  Build the protocol, client and server from source and send patches upstream.
  :::
::

::u-page-section{class="dark:bg-gradient-to-b from-neutral-950 to-neutral-900"}
  :::u-page-c-t-a
  ---
  links:
    - label: Read the introduction
      to: https://docs.spoutcraftredux.org/getting-started
      trailingIcon: i-lucide-arrow-right
    - label: View on GitHub
      to: https://github.com/SpoutCraftRedux
      target: _blank
      variant: subtle
      icon: i-simple-icons-github
  class: dark:bg-neutral-950
  description: SpoutCraft Redux is in early development. The handshake works
    today; GUIs, HUD, sky and the rest of the API arrive over the next phases.
  title: Follow along from Phase 0
  ---
    ::::stars-bg
    ::::
  :::
::

## Resources for Agents

- [API catalog: every service document this site publishes](https://docs.spoutcraftredux.org/.well-known/api-catalog)
- [Sitemap (Markdown): every page on the site](https://docs.spoutcraftredux.org/sitemap.md)
- [llms.txt: index of the documentation for LLMs](https://docs.spoutcraftredux.org/llms.txt)
- [llms-full.txt: the full documentation as a single file](https://docs.spoutcraftredux.org/llms-full.txt)


## Sitemap

See the full [sitemap](https://docs.spoutcraftredux.org/sitemap.md) for all pages.
