Spout server / Spoutcraft client
(Paper, Fabric)

Vanilla-compatible server + client
that automatically sends modded content from server to client

Server

Introduction

Spout lets you add new blocks and items on a Paper server, fully server-side.
When players join, the new blocks and items will be added client-side too.

    ✓  Automatically sends custom content to clients with the Spoutcraft mod
    ✓  Works with other clients too, including vanilla (with/without resource pack)
    ✓  Support for all Bukkit / Spigot / Paper plugins

A Fabric server mod is planned. Please let us know on Discord if you are interested.

Downloads

Installation

The .jar file is a drop-in replacement for the Paper JAR, and you can run it the same:

java -jar spout-26.1.2-R1.8.jar

Please report any issues you encounter. As always, backup your server regularly.

Adding custom blocks and items

New blocks and items can be added by Paper plugins that support Spout.

Spout plugin showcase

• Quark
• Chinese paper lamps
• Snowy stone bricks

Creating a Spout plugin

It's very simple:

1. Create a regular Paper plugin
2. Add the Spout API as a dependency
3. Define your content with a data and resource pack

See the step-by-step guide on the wiki!

Current known issues

• Vanilla clients cannot see block display entities, falling blocks and stonecutter recipes for custom blocks.

Client

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
    ✓  Supports all properties, including breaking speed, light level and textures
    ✓  Auto-completion in commands, such as /give

Because it contains no modded blocks or items of itself, the Spoutcraft client mod is super lightweight.
It is incredibly fast: a server's modded content is downloaded and added in less than a second.
The client only accepts a server's text description of block and item types. No server code is ever transferred or executed.
All custom content is automatically removed the moment you leave a server.

Downloads

Installation

Place the .jar file into the mods folder.

Requires Fabric API.

Compatibility with other mods has not been explored fully.
Please report if you encounter any issues.

Acknowledgements

This project is heavily inspired by the original Spoutcraft / BukkitContrib project. This project would not exist without the ideas and work that those who worked on it put forward. Additionally, this project builds on top of the work of the contributors to Paper and Spigot, and Fabric and Sponge.

Also, thanks go out to Alvinn8, SoSeDiK and zoumath19 for their contributions to this project.