What is SpoutPlugin?

SpoutPlugin, formerly BukkitContrib, is a framework to bridge the ever-widening chasm between single player mods, and multiplayer Bukkit plugins. On its own, it does very little. Expect no changes beyond some interface enhancements and minor speed improvements on the client and moderate speed improvements on the server. Through it, Bukkit plugins can do the previously impossible. Currently, plugins can seamlessly manipulate and monitor inventory, audio, sound effects, skins, player titles, alter the main in-game HUD, and launch popup notifications on the player's client. Many of these features require Spoutcraft. And the future is even better. Spout plans to create a client side plugin system, which will unlock the ability to add custom blocks, mobs, and items to the game. Imagine joining one server, and having it automagically download all the new game content and install it seamlessly. Then, log out and join the next server, totally vanilla, without ever closing the game. With Spout there is no "this isn't possible" replies anymore. Now, it's either "Yes", or "Yes, in the future".

How do I get started?

Visit http://www.spout.org for more details.

What are the server-side features?

• Chunk caching for those with the client, saving bandwidth for the server AND players. (Currently broken)
• Teleport smoothing which loads the chunks before you get there in a smart way.
• Control of visual cheats by the admin (coordinates, disabling weather, etc).
• Option to force players to use the Spoutcraft client.

What does the plugin API provide?

(Players DO NOT need the Spoutcraft client installed)

• OnServerTick event
• Safe async block set type id
• Access to crafting matrix (workbench, inventory)

What does the plugin API + client provide?

(Players DO need the Spoutcraft client mod installed)

GUI

• Custom GUI API to make your own screens and HUD elements
• Custom achievement notifications

Visual

• Custom skins, capes, and multi-line capable titles
• Custom item textures
• Custom item hover-over names
• Control texture packs
• Control star frequency
• Control sky and cloud colors
• Control cloud height/visibility
• Control sun and moon texture and size
• Control weather rendering for biomes
• Maximum/minimum fog levels
• New! Particle effects API

Audio

• Play Minecraft sound effects and music
• Play custom sound effects and music
• Stop music playback with fade out

Events

• Key press and release
• Background music change
• Change fog and fog change

Movement

• Control jump height
• Control gravity
• Control speed in air, on the ground, and while swimming

Misc

• Pre-cache custom textures/sounds/other things your plugin uses on login.
• Server reconnect API
• New! Waypoints and deathpoints API
• Clipboard get/set