SpoutAPI

SpoutAPI is an API for the spout framework. Spout is a plugin for Bukkit-based servers and a Minecraft client mod system that exposes new API for other plugins to utilize, in an attempt to bring the Minecraft Multiplayer experience to parity with the single player modding experience.

Copyright © 2011, Afforess [email protected]
Spout is licensed under GNU LESSER GENERAL PUBLIC LICENSE Version 3

Visit our website.
Get support on our Bukkit forum thread.
Track and submit issues and bugs on our issue tracker.

Follow Spout on Twitter @Afforess

Source

The latest and greatest source of Spout can be found on GitHub.
Download the latest builds from Jenkins.
View the latest Javadoc.

Compiling

Spout uses Maven to handle it's dependencies.

Spout requires CraftBukkit (preferrably the latest version or source).

• Install Maven 2 or 3
• Checkout this repo and run: mvn clean package

Spout SP requires the Minecraft Coder Pack.

• Download and extract the latest version of Minecraft Coder Pack.
• Copy the latest complete Minecraft bin directory from your computer.
• Place the Minecraft bin directory under MCP's jars directory.
• Checkout or copy the latest source fro the Spout SP repo.
• Checkout or copy the conf directory of files from the Spout SP repo to MCP's conf directory.
• Run cleanup, decompile, recompile, and reobfuscate (.bat for Windows or .sh for Linux).
• When tasks are finished, the compiled Spout class files will be located in reobf.

Coding and Pull Request Formatting

• Generally follows the Oracle coding standards.
• Spout uses tabs, no spaces.
• No 80 column limit or midstatement newlines.
• Pull requests must compile and work.
• Pull requests must be formatted properly.
• When modifying Notch code (Minecraft vanilla code), include //Spout Startand //Spout end

Please follow the above conventions if you want your pull requests accepted.