<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sponge Documentation — Sponge 6.0.0 documentation</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/spongedocs.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/> <link rel="search" title="Search" href="search.html"/> <link rel="top" title="Sponge 6.0.0 documentation" href="#"/> <link rel="next" title="Creating a Server" href="server/index.html"/>
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59476017-2', 'auto');
ga('send', 'pageview');
</script>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div id="sp-logo-container" class="page-scroll">
<a class="logo" href="#">
<img src="_static/spongie-mark-dark.svg">
<span>Sponge</span>
<i class="fa fa-fw fa-chevron-down"></i>
</a>
<div id="sp-logo-menu">
<ul id="sp-logo-dropdown">
<li><a href="https://www.spongepowered.org"><i class="fa-fw fa fa-home"></i>Homepage</a></li>
<li><a href="https://forums.spongepowered.org"><i class="fa-fw fa fa-comments"></i>Forums</a></li>
<li><a href="https://github.com/SpongePowered"><i class="fa-fw fa fa-code"></i>Code</a></li>
<li class="active"><a href="https://docs.spongepowered.org"><i class="fa-fw fa fa-book"></i>Docs</a></li>
<li><a href="https://jd.spongepowered.org"><i class="fa-fw fa fa-graduation-cap"></i>Javadocs</a></li>
<li><a href="https://forums.spongepowered.org/c/plugins/plugin-releases"><i class="fa-fw fa fa-plug"></i>Plugins</a></li>
<li><a href="https://www.spongepowered.org/downloads"><i class="fa-fw fa fa-download"></i>Downloads</a></li>
<li><a href="https://www.spongepowered.org/chat"><i class="fa-fw fa fa-comment"></i>Chat</a></li>
</ul>
</div>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Creating a Server</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="preparing/index.html">Preparing for Development</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="plugin/index.html">Creating a Plugin</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ore/index.html">Ore Documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing to Sponge</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">About the Sponge Project</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Sponge</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Sponge Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/Update-to-API6/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="sponge-documentation">
<h1>Sponge Documentation<a class="headerlink" href="#sponge-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>Welcome to SpongeDocs, the official documentation for the open-source <a class="reference external" href="https://www.spongepowered.org">Sponge</a> project.</p>
<p>The SpongeAPI is your all new plugin API for Minecraft. You can run it on a plain vanilla server (as SpongeVanilla) or
on your fully modded MinecraftForge server (as SpongeForge). Grab your copy
<a class="reference external" href="https://spongepowered.org/downloads">here</a>.</p>
<p>Not sure what you’re looking for? Try our <a class="reference internal" href="about/index.html"><span class="doc">About the Sponge Project</span></a> section, which contains a short <a class="reference internal" href="about/introduction.html"><span class="doc">Introduction</span></a>,
our <a class="reference internal" href="about/faq.html"><span class="doc">Frequently Asked Questions</span></a> and an article about <a class="reference internal" href="about/structure.html"><span class="doc">The Structure of the Sponge Project</span></a>.</p>
<p>Server owners should read our tips and instructions in <a class="reference internal" href="server/index.html"><span class="doc">Creating a Server</span></a> on how to install, run and maintain a Sponge
based server.</p>
<p>The Sponge project has several main components. Learn more about the project structure <a class="reference internal" href="about/structure.html"><span class="doc">here</span></a>
or visit their repositories on GitHub:</p>
<p><a class="reference external" href="https://github.com/spongepowered/spongeforge">SpongeForge</a> |
<a class="reference external" href="https://github.com/spongepowered/spongevanilla">SpongeVanilla</a> | <a class="reference external" href="https://github.com/spongepowered/spongeapi">SpongeAPI</a> |
<a class="reference external" href="https://github.com/spongepowered/spongedocs">SpongeDocs</a> | <a class="reference external" href="https://github.com/SpongePowered/SpongeHome">SpongeHome</a> |
<a class="reference external" href="https://github.com/SpongePowered/Mixin">Mixin</a> | <a class="reference external" href="https://github.com/SpongePowered/Ore">Ore</a></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Sponge development is ongoing. Beta and Experimental builds of both SpongeForge and SpongeVanilla are currently
available for <a class="reference external" href="https://spongepowered.org/downloads">download</a>.</p>
</div>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="section" id="creating-a-server">
<h3>Creating a Server<a class="headerlink" href="#creating-a-server" title="Permalink to this headline">¶</a></h3>
<p>This section is for users who have a Sponge server or are interested in creating one.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Creating a Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="server/getting-started/index.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="server/management/index.html">Server Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="server/spongineer/index.html">Becoming an Expert Spongineer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="preparing-for-development">
<h3>Preparing for Development<a class="headerlink" href="#preparing-for-development" title="Permalink to this headline">¶</a></h3>
<p>Get yourself and your machine ready to develop Sponge itself or your own plugins! Please read this section before
<a class="reference internal" href="plugin/index.html"><span class="doc">Creating a Plugin</span></a> and <a class="reference internal" href="contributing/index.html"><span class="doc">Contributing to Sponge</span></a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="preparing/index.html">Preparing for Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="preparing/jdk.html">Installing the JDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="preparing/ide.html">Installing an IDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="preparing/text.html">Installing a Text Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="preparing/git.html">Installing Git</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="creating-plugins">
<h3>Creating Plugins<a class="headerlink" href="#creating-plugins" title="Permalink to this headline">¶</a></h3>
<p>Need help and information while coding your plugin for the SpongeAPI? Look no further!</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="plugin/index.html">Creating a Plugin</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugin/buildsystem.html">Build Systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/workspace/index.html">Setting Up Your Workspace</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/project/index.html">Setting Up Your Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/plugin-identifier.html">Plugin Identifiers</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/plugin-class.html">Main Plugin Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/lifecycle.html">Plugin Lifecycle</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/injection.html">Dependency Injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/practices.html">Best Practices</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/optional/index.html">Optionals</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/logging.html">Logging and Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/commands/index.html">Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/event/index.html">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/assets.html">The Asset API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/configuration/index.html">Configuring Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/text/index.html">Text</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/data/index.html">The Data API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/blocks/index.html">Blocks</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/entities/index.html">Entities</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/items/index.html">Items</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/trade-offers.html">Trade-Offers</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/effects.html">Effects</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/scheduler.html">Scheduler</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/services.html">Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/database.html">Databases</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/permissions.html">Permissions</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/bans.html">Bans</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/bookview.html">Book Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/economy/index.html">Economy</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/wgen/index.html">World Generation</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/manager.html">Plugin Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/game-profile-manager.html">Game Profile Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/offline-userplayer-data.html">Offline Player Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/debugging.html">Plugin Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/tab-lists.html">Tab Lists</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/plugin-meta.html">Plugin Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/ray-tracing.html">Ray Tracing</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/tutorials.html">Tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/internals/index.html">Implementation-dependent Plugins</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="id1">
<h3>Ore<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>Learn how to publish, install, browse, and use our Web API for our custom built plugin hosting solution, Ore.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="ore/index.html">Ore Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ore/guidelines.html">Ore Plugin Submission Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore/guidelines.html#projects">Projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore/guidelines.html#files">Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore/publish.html">Publishing Your Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore/api.html">Ore Web API</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="contributing-to-sponge">
<h3>Contributing to Sponge<a class="headerlink" href="#contributing-to-sponge" title="Permalink to this headline">¶</a></h3>
<p>Look here if you want to help out in making Sponge better. Make Spongie proud!</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing to Sponge</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing/guidelines.html">Contribution Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/howtogit.html">How to Git(Hub)</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/implementation/index.html">Developing Sponge</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/spongedocs.html">SpongeDocs Writing</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/porting.html">Porting Sponge to Other Platforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/versioning.html">Versioning System and Repository Branch Layout</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="about-sponge">
<h3>About Sponge<a class="headerlink" href="#about-sponge" title="Permalink to this headline">¶</a></h3>
<p>This section contains basic information about the project, read this if you’re confused about Sponge, its parts, or our
goals.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">About the Sponge Project</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/structure.html">The Structure of the Sponge Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html">Plans for the Future</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/license.html">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/posting.html">Forum Posting Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/rules.html">Forum & IRC Rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/staff.html">Staff</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/glossary.html">Sponge Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/assets.html">Art Assets</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/history.html">The History of Sponge</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="acknowledgements">
<h3>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h3>
<img alt="_images/yklogo.png" src="_images/yklogo.png" />
<p>The SpongePowered team are grateful to <em>YourKit</em> for providing its full-featured Java Profiler free to open source
projects. YourKit, LLC is the creator of <a class="reference external" href="https://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a>
and <a class="reference external" href="https://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>, innovative and intelligent tools
for profiling Java and .NET applications.</p>
</div>
</div>
<div class="section" id="links">
<h2>Links<a class="headerlink" href="#links" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
</div>
<ul class="simple">
<li><a class="reference external" href="https://spongepowered.org">Sponge Homepage</a></li>
<li><a class="reference external" href="https://forums.spongepowered.org">Sponge Forums</a></li>
<li><a class="reference external" href="https://discord.gg/qXD2weC">Sponge Discord</a></li>
<li><a class="reference external" href="https://spongepowered.org/downloads">Sponge Downloads</a></li>
<li><a class="reference external" href="https://github.com/SpongePowered/SpongeAPI/issues?q=">SpongeAPI Issue Tracker</a></li>
<li><a class="reference external" href="https://jd.spongepowered.org">SpongeAPI Javadocs</a></li>
<li><a class="reference external" href="https://twitter.com/SpongePowered">Sponge Twitter</a></li>
<li><a class="reference external" href="https://reddit.com/r/SpongeProject">Sponge Subreddit</a></li>
<li><a class="reference external" href="https://github.com/SpongePowered">Sponge GitHub</a></li>
<li><a class="reference external" href="https://www.patreon.com/Sponge?ty=h">Sponge Patreon Donation Page</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="server/index.html" class="btn btn-neutral float-right" title="Creating a Server" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2017, Sponge Contributors.
</p>
</div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<i class="fa fa-book"> <span>SpongeDocs</span></i>
v: 6.0.0
<span class="fa fa-caret-down"></span>
</span>
<div id="versions" class="rst-other-versions">
<dl>
<dt>Contribute</dt>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/blob/Update-to-API6/source/index.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/Update-to-API6/source/index.rst">Edit</a></dd>
</dl>
</div>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/spongedocs.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>