Spoutcraft
A client mod that automatically installs custom blocks and items when joining a server.
Spoutcraft
<div align="center">
<h1> Spoutcraft<br>client mod (Fabric) </h1> <h3> Automatically downloads and adds modded content <br> when joining a server </h3> <br>
</div>
<table> <tr> <td> <img src="https://raw.githubusercontent.com/ModernSpout/Spout-Paper-server/refs/heads/master/design/lantern_small.png" alt="A Chinese paper lamp post in a cherry grove"> </td> <td> <img src="https://raw.githubusercontent.com/ModernSpout/Spout-Paper-server/refs/heads/master/design/concrete_small.png" alt="Stairs and slabs of colored wool, concrete and terracotta"> </td> <td> <img src="https://raw.githubusercontent.com/ModernSpout/Spout-Paper-server/refs/heads/master/design/orange_small.png" alt="A tree with orange leaves"> </td> </tr> </table>
Introduction
Spoutcraft works like a per-server modloader: the moment you join a Spout server, the server's modded content will be transferred and added client-side automatically.
✓ Supports non-vanilla block shapes, like vertical slabs <br> ✓ Supports all properties, including breaking speed, light level and textures <br> ✓ Auto-completion in commands, such as <code>/give</code>
Because it contains no modded block or items of itself, the Spoutcraft client mod is super lightweight. <br> It is incredibly fast: a server's modded content is downloaded and added in less than a second. <br> The client only accepts a server's text description of block and item types. No server code is ever transferred or executed. <br> All custom content is automatically removed the moment you leave a server.
Installation
Place the `.jar` file into the `mods` folder (or use the Modrinth App).
Requires Fabric API.
<div align="center"> <table> <tr> <td valign="center"> <h1>🔨</h1> </td> <td valign="center"> Spoutcraft has been tested, but compatibility with other mods has not been explored fully. <br> Please report if you encounter any issues. </td> </tr> </table> </div>
Installing Spout server-side
* Paper/Spigot/Bukkit: Spout (for Paper) * Fabric: currently being developed, please let us know on Discord if you are interested!