<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Frequently Asked Questions — Sponge 5.0.0 documentation</title>
<link rel="stylesheet" href="../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../_static/sponge.css" type="text/css" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css" />
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:400italic,700italic,700,400|Montserrat:400,700" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="../_static/tomorrow.css" type="text/css" />
<link id="syntax-highlighting-ref" rel="stylesheet" href="../_static/tomorrow_night.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '5.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/store.min.js"></script>
<script type="text/javascript" src="../_static/lights.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Sponge 5.0.0 documentation" href="../index.html" />
<link rel="up" title="About the Sponge Project" href="index.html" />
<link rel="next" title="The Structure of the Sponge Project" href="structure.html" />
<link rel="prev" title="Introduction" href="introduction.html" />
<script type="text/javascript">
(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','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59476017-2', 'auto');
ga('send', 'pageview');
</script>
{§#curver§}
{|#langs|}
<link rel="alternate" hreflang="{|crowdin_code|}" href="/{§currentversion§}/{|crowdin_code|}/">
{|/langs|}
{§/curver§}
<link rel="alternate" hreflang="x-default" href="/">
</head>
<body role="document" id="top">
<div class="topbar">
<div role="navigation" aria-label="related navigation">
<div class="sp-logo-container sp-not-mobileview sp-mobileview">
<a class="sp-logo-link" data-auto-route="true" href="/">
<img height="40px" id="site-logo" class="logo-big" alt="" src="https://www.spongepowered.org/assets/img/icons/spongie-mark.svg">
<span id="sp-site-title">Sponge</span>
</a>
<div class="sp-logo-bg"></div>
<div class="sp-logo-chevron"><i class="fa fa-fw fa-chevron-down"></i></div>
<div class="sp-logo-menu sp-skip-handler">
<ul class="sp-logo-dropdown" id="ddleft">
<a href="https://www.spongepowered.org"><li><i class="fa-fw fa fa-home"></i>Homepage</li></a>
<a href="https://forums.spongepowered.org"><li><i class="fa-fw fa fa-comments"></i>Forums</li></a>
<a href="https://github.com/SpongePowered"><li><i class="fa-fw fa fa-code"></i>Code</li></a>
<a class="sp-forums-home" href="https://docs.spongepowered.org"><li class="active"><i class="fa-fw fa fa-book"></i>Docs</li></a>
<a href="https://jd.spongepowered.org"><li><i class="fa-fw fa fa-graduation-cap"></i>Javadocs</li></a>
<a href="https://forums.spongepowered.org/c/plugins/plugin-releases"><li><i class="fa-fw fa fa-plug"></i>Plugins</li></a>
<a href="https://www.spongepowered.org/downloads"><li><i class="fa-fw fa fa-download"></i>Downloads</li></a>
<a href="https://www.spongepowered.org/chat"><li><i class="fa-fw fa fa-comment"></i>Chat</li></a>
</ul>
</div>
</div>
<div class="menu-right">
<div><i class="fa fa-fw fa-globe"></i></div>
<ul class="dropdown" id="ddlang">
{§#curver§}
{|#langs|}
<li><a href="/{§currentversion§}/{|crowdin_code|}/" class="lang"><img src="//d1ztvzf22lmr1j.cloudfront.net/images/flags/{|crowdin_code|}.png" alt="Flag for {|name|}"/></a></li>
{|/langs|}
{§/curver§}
</ul>
</div>
<div class="menu-right">
<div><i class="fa fa-fw fa-tag"></i><a>5.0.0</a></div>
<ul class="dropdown" id="ddvers">
<li><a href="/master/en/"><i class="fa fa-fw fa-tag"></i> latest</a></li>
{[#vers]}
<li><a href="/{[apiversion]}/en/"><i class="fa fa-fw fa-tag"></i> {[apiversion]}</a></li>
{[/vers]}
</ul>
</div>
<div class="menu-right">
<div title="Toggle syntax highlighting between light and dark" class="lights">
<i class="fa fa-fw fa-lightbulb-o"></i>
</div>
</div>
<div>
<ul class="controls">
<li>|</li>
<li><a href="structure.html" title="Next Page"><i class="fa fa-fw fa-chevron-right"></i></a></li>
<li><a href="#top" title="To the top"><i class="fa fa-fw fa-chevron-up"></i></a></li>
<li><a href="../index.html" title="Home"><i class="fa fa-fw fa-home"></i></a></li>
<li><a href="introduction.html" title="Previous Page"><i class="fa fa-fw fa-chevron-left"></i></a></li>
<li>|</li>
<li><a href="https://github.com/SpongePowered/SpongeDocs/blob/master/source/about/faq.rst" title="Edit on GitHub"><i class="fa fa-fw fa-github"></i></a></li>
</ul>
</div>
<h3>Navigation</h3>
</div>
</div>
<div class="container">
<div class="breadcrumbs">
<ul>
<li><a href="../index.html">Sponge 5.0.0 documentation</a><i class="fa fa-fw fa-chevron-right"></i></li>
<li><a href="index.html" accesskey="U">About the Sponge Project</a><i class="fa fa-fw fa-chevron-right"></i></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<form class="search" action="../search.html" method="get">
<div class="searchbox-inner">
<input class="field" type="text" name="q" autocomplete="off" />
<button class="submit" type="submit"><i class="fa fa-fw fa-search" aria-hidden="true"></i></button>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</div>
</form>
<p class="searchtip" style="font-size: 90%"></p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><h3><a href="../index.html">Table Of Contents</a></h3>
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/jre.html">Installing Java</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/migrating.html">Migrating to Sponge</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/implementations/index.html">Choosing an Implementation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/implementations/spongeforge.html">Installing SpongeForge</a></li>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/implementations/spongevanilla.html">Installing SpongeVanilla</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/launch-script.html">Creating a Launch Script</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/port-forward.html">Port Forwarding</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/bungeecord.html">Using Sponge with BungeeCord</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/getting-started/configuration/index.html">Configuring Sponge</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/configuration/hocon.html">Introduction to HOCON</a></li>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/configuration/json.html">JSON Syntax</a></li>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/configuration/sponge-conf.html">global.conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="../server/getting-started/configuration/server-properties.html">server.properties</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../server/management/index.html">Server Management</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../server/management/whitelist.html">Managing the Whitelist</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/management/bans.html">Managing Bans</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/management/permissions.html">Managing Permissions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/management/plugins.html">Installing Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/management/exploit-patches.html">Exploit Patches</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/management/performance-tweaks.html">Performance Tweaks</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../server/spongineer/index.html">Becoming an Expert Spongineer</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../server/spongineer/commands.html">Commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/spongineer/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/spongineer/logs.html">Log Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/spongineer/debugging.html">Debugging</a></li>
<li class="toctree-l3"><a class="reference internal" href="../server/spongineer/bugreport.html">Reporting Bugs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<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>
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/workspace/idea.html">Setting Up IntelliJ IDEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/workspace/eclipse.html">Setting Up Eclipse</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/project/index.html">Setting Up Your Project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/project/gradle.html">Setting Up Gradle</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/project/maven.html">Setting Up Maven</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/optional/basic.html">Optionals Explained</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/optional/usage.html">Usage Examples</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/creating.html">Building a Command</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/arguments.html">Argument Parsing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/flags.html">Command Flags</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/childcommands.html">Child Commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/service.html">The Command Manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/commands/commandcallable.html">Low-Level Command API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/event/index.html">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/event/listeners.html">Event Listeners</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/event/causes.html">Event Causes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/event/filters.html">Event Filters</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/event/custom.html">Custom Events</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/configuration/loaders.html">Configuration Loaders</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/configuration/nodes.html">Configuration Nodes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/configuration/serialization.html">Serializing Objects</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/text/index.html">Text</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/text/text.html">Creating Text</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/text/representations/index.html">Text Serializers</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../plugin/text/representations/formatting-code-legacy.html">Formatting Code & Legacy Format</a></li>
<li class="toctree-l4"><a class="reference internal" href="../plugin/text/representations/xml.html">TextXML Format</a></li>
<li class="toctree-l4"><a class="reference internal" href="../plugin/text/representations/json.html">JSON Format</a></li>
<li class="toctree-l4"><a class="reference internal" href="../plugin/text/representations/configurate.html">Configuration Format</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/text/pagination.html">The Pagination Service</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/text/messagechannels.html">Message Channels</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/text/templates.html">TextTemplates</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/data/index.html">The Data API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/data/custom/index.html">Custom Data</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../plugin/data/custom/datamanipulators.html">Custom DataManipulators</a></li>
<li class="toctree-l4"><a class="reference internal" href="../plugin/data/custom/dataholders.html">Custom DataHolders</a></li>
<li class="toctree-l4"><a class="reference internal" href="../plugin/data/custom/serialization.html">Serializing Custom Data</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/data/keys.html">Using Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/data/datamanipulators.html">Data Manipulators</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/data/transactions.html">Transactions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/data/serialization.html">Serializing Data</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/blocks/index.html">Blocks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/blocks/concepts.html">Concepts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/blocks/accessing.html">Accessing Blocks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/blocks/modifying.html">Modifying Blocks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/blocks/tileentities.html">Tile Entities</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/blocks/virtualblock.html">Virtual Block Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/entities/index.html">Entities</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/entities/spawning.html">Spawning an Entity</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/entities/modifying.html">Modifying an Entity</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/items/index.html">Items</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/items/usage.html">Basic Item Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/items/creating.html">Creating an ItemStack</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/economy/basics.html">Basic Concepts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/economy/using.html">Using the Economy API</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/economy/practices.html">Economy API Best Practices</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/economy/implementing.html">Implementing the Economy API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../plugin/wgen/index.html">World Generation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin/wgen/modifiers.html">WorldGeneratorModifiers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin/wgen/customwgen.html">Modifying World Generation</a></li>
</ul>
</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>
</ul>
</li>
</ul>
<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/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><ul>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/list-projects.html">List projects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/project.html">Get Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/list-versions.html">List Project Versions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/project-version.html">Get Project Version</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/list-users.html">List Users</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/user.html">Get User</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ore/routes/download.html">Download Project Version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/codestyle.html">Code Style</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/git-implementation.html">Git Workflow for API and Implementations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/pr.html">Submitting a Pull-Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/debugging.html">Debugging Sponge Within the IDE</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/mixins.html">Mixins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/implementation/datamanipulator.html">Implementing DataManipulators</a></li>
</ul>
</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>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">About the Sponge Project</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Frequently Asked Questions</a></li>
<li class="toctree-l2"><a class="reference internal" href="structure.html">The Structure of the Sponge Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="future.html">Plans for the Future</a></li>
<li class="toctree-l2"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="posting.html">Forum Posting Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="rules.html">Forum & IRC Rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="staff.html">Staff</a></li>
<li class="toctree-l2"><a class="reference internal" href="glossary.html">Sponge Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="assets.html">Art Assets</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html">The History of Sponge</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="frequently-asked-questions">
<h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#for-everyone" id="id1">For Everyone</a><ul>
<li><a class="reference internal" href="#what-is-sponge" id="id2">What is Sponge?</a></li>
<li><a class="reference internal" href="#what-is-required-to-run-sponge" id="id3">What is required to run Sponge?</a></li>
<li><a class="reference internal" href="#where-do-i-get-sponge" id="id4">Where do I get Sponge?</a></li>
<li><a class="reference internal" href="#what-sponge-implementations-are-available" id="id5">What Sponge implementations are available?</a></li>
<li><a class="reference internal" href="#where-do-i-get-plugins-for-sponge" id="id6">Where do I get Plugins for Sponge?</a></li>
<li><a class="reference internal" href="#what-happened-to-bukkit" id="id7">What happened to Bukkit?</a></li>
<li><a class="reference internal" href="#can-i-run-bukkit-plugins-with-this" id="id8">Can I run Bukkit Plugins with this?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#for-server-owners" id="id9">For Server Owners</a><ul>
<li><a class="reference internal" href="#i-m-a-server-owner-how-will-switching-to-sponge-affect-my-server" id="id10">I’m a Server Owner! How Will Switching to Sponge Affect My Server?</a></li>
<li><a class="reference internal" href="#how-will-switching-to-sponge-affect-players-on-my-server" id="id11">How Will Switching to Sponge Affect Players on My Server?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#for-developers" id="id12">For Developers</a><ul>
<li><a class="reference internal" href="#what-can-i-do-with-sponge" id="id13">What can I do with Sponge?</a></li>
<li><a class="reference internal" href="#what-can-t-i-do-with-sponge-limitations-of-sponge" id="id14">What can’t I do with Sponge? / Limitations of Sponge?</a></li>
<li><a class="reference internal" href="#i-m-a-bukkit-plugin-developer-why-can-t-sponge-use-bukkit-s-api" id="id15">I’m a Bukkit Plugin Developer! Why Can’t Sponge Use Bukkit’s API?</a></li>
<li><a class="reference internal" href="#will-i-be-able-to-access-the-server-internals-in-my-plugins" id="id16">Will I Be Able to Access the Server Internals In My Plugins?</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="for-everyone">
<h2><a class="toc-backref" href="#id1">For Everyone</a><a class="headerlink" href="#for-everyone" title="Permalink to this headline">¶</a></h2>
<div class="section" id="what-is-sponge">
<h3><a class="toc-backref" href="#id2">What is Sponge?</a><a class="headerlink" href="#what-is-sponge" title="Permalink to this headline">¶</a></h3>
<p>Sponge is a new versatile Minecraft API. It was made to enrich your Minecraft experience by allowing plugins to add
functionality to Minecraft. Read more about Sponge here: <a class="reference internal" href="introduction.html"><span class="doc">Introduction</span></a> and about the history of Sponge here:
<a class="reference internal" href="history.html"><span class="doc">The History of Sponge</span></a></p>
</div>
<div class="section" id="what-is-required-to-run-sponge">
<h3><a class="toc-backref" href="#id3">What is required to run Sponge?</a><a class="headerlink" href="#what-is-required-to-run-sponge" title="Permalink to this headline">¶</a></h3>
<p>Sponge (and Minecraft) needs the Java Runtime Environment to run properly. You will obviously need a computer to run
the server on too, besides that nothing is required. Learn more about choosing the correct Java version here:
<a class="reference internal" href="../server/getting-started/jre.html"><span class="doc">Installing Java</span></a></p>
</div>
<div class="section" id="where-do-i-get-sponge">
<h3><a class="toc-backref" href="#id4">Where do I get Sponge?</a><a class="headerlink" href="#where-do-i-get-sponge" title="Permalink to this headline">¶</a></h3>
<p>Beta development builds of SpongeForge and SpongeVanilla are already available:
<a class="reference external" href="https://spongepowered.org/downloads">Sponge Downloads</a></p>
</div>
<div class="section" id="what-sponge-implementations-are-available">
<h3><a class="toc-backref" href="#id5">What Sponge implementations are available?</a><a class="headerlink" href="#what-sponge-implementations-are-available" title="Permalink to this headline">¶</a></h3>
<p>The Sponge Project currently develops two implementations which both use the SpongeAPI:</p>
<ol class="arabic simple">
<li><strong>SpongeForge</strong>, a coremod for Minecraft Forge, which is an existing Minecraft modding framework famous for spurring
the Minecraft modding scene. Forge lacks a cross-version API, and this is where Sponge steps in. Sponge allows
server owners to deploy Sponge plugins with ease, making server management easier.
(SpongeForge was formerly known as Sponge, until it was renamed to avoid confusion).</li>
<li><strong>SpongeVanilla</strong>, a stand-alone implementation of the Sponge API, running on top of the vanilla Minecraft server.
(SpongeVanilla was formerly known as Granite, until the development teams merged).</li>
</ol>
</div>
<div class="section" id="where-do-i-get-plugins-for-sponge">
<h3><a class="toc-backref" href="#id6">Where do I get Plugins for Sponge?</a><a class="headerlink" href="#where-do-i-get-plugins-for-sponge" title="Permalink to this headline">¶</a></h3>
<p>On our official plugin repository, which is called Ore. Development has already started on GitHub. Temporarily, plugins
are hosted on the <a class="reference external" href="https://forums.spongepowered.org/c/plugins/plugin-releases">SpongeForums</a>.</p>
</div>
<div class="section" id="what-happened-to-bukkit">
<h3><a class="toc-backref" href="#id7">What happened to Bukkit?</a><a class="headerlink" href="#what-happened-to-bukkit" title="Permalink to this headline">¶</a></h3>
<p>The Bukkit project halted further development of their API and server modification. Shortly thereafter, one of the
contributors to Bukkit sent a DMCA takedown notice to stop further distribution of CraftBukkit. He was within his legal
right. Downloads, as well as source code, for CraftBukkit and its derivatives (such as Spigot and Cauldron) are no
longer publicly available. If you want to know the reasons why this affected Sponge development, have a look at our
history page: <a class="reference internal" href="history.html"><span class="doc">The History of Sponge</span></a></p>
</div>
<div class="section" id="can-i-run-bukkit-plugins-with-this">
<h3><a class="toc-backref" href="#id8">Can I run Bukkit Plugins with this?</a><a class="headerlink" href="#can-i-run-bukkit-plugins-with-this" title="Permalink to this headline">¶</a></h3>
<p>Sadly no, not natively. Sponge is using its own API (Sponge API), while Bukkit is using the Bukkit API. However there is the
possibility that a third-party plugin for Sponge implements the Bukkit API on top of Sponge API.</p>
</div>
</div>
<div class="section" id="for-server-owners">
<h2><a class="toc-backref" href="#id9">For Server Owners</a><a class="headerlink" href="#for-server-owners" title="Permalink to this headline">¶</a></h2>
<div class="section" id="i-m-a-server-owner-how-will-switching-to-sponge-affect-my-server">
<h3><a class="toc-backref" href="#id10">I’m a Server Owner! How Will Switching to Sponge Affect My Server?</a><a class="headerlink" href="#i-m-a-server-owner-how-will-switching-to-sponge-affect-my-server" title="Permalink to this headline">¶</a></h3>
<p>For an existing Forge server, you will need to download Sponge and place it into the mods folder. The server can then
be started like any other Forge server.</p>
<p>Non-Forge servers may elect to use SpongeVanilla instead, an implementation that does not rely on Forge. There are
guides for migrating from Bukkit and/or Canary elsewhere on SpongeDocs. It is worth noting that many plugin developers
from the Bukkit community have thrown their weight behind Sponge, and are planning to make their plugins available for
Sponge-powered servers.</p>
<p>Worlds will be able to be ported over. It is up to plugin developers to create conversion processes that will allow you
to keep plugin data, if any exists. Some plugin developers may not do this.</p>
<p>On a related note, we will not be providing support for Bukkit plugins on Sponge. However, it may be possible for a
third-party to create a way for Bukkit plugins to work on Sponge.</p>
</div>
<div class="section" id="how-will-switching-to-sponge-affect-players-on-my-server">
<h3><a class="toc-backref" href="#id11">How Will Switching to Sponge Affect Players on My Server?</a><a class="headerlink" href="#how-will-switching-to-sponge-affect-players-on-my-server" title="Permalink to this headline">¶</a></h3>
<p>Switching to Sponge should not affect players on your server. If you (as a server owner) migrate correctly, players will
be able to connect to your server the same way as they did before you migrated to Sponge. They will not need to have
Forge installed - unless your server runs Forge mods, of course.</p>
</div>
</div>
<div class="section" id="for-developers">
<h2><a class="toc-backref" href="#id12">For Developers</a><a class="headerlink" href="#for-developers" title="Permalink to this headline">¶</a></h2>
<div class="section" id="what-can-i-do-with-sponge">
<h3><a class="toc-backref" href="#id13">What can I do with Sponge?</a><a class="headerlink" href="#what-can-i-do-with-sponge" title="Permalink to this headline">¶</a></h3>
<p>Sponge provides a Plugin API. This means that you can create new content and gamemodes on the go.
Have a look at our plugin pages to get a quick-start: <a class="reference internal" href="../plugin/index.html"><span class="doc">Creating a Plugin</span></a></p>
</div>
<div class="section" id="what-can-t-i-do-with-sponge-limitations-of-sponge">
<h3><a class="toc-backref" href="#id14">What can’t I do with Sponge? / Limitations of Sponge?</a><a class="headerlink" href="#what-can-t-i-do-with-sponge-limitations-of-sponge" title="Permalink to this headline">¶</a></h3>
<p>Sponge can’t be used to create new blocks, textures, mobs on the clientside or any other content which would need
clientside modifications. The Sponge API wont support sending mods or plugins to the client for now due to security
concerns. However you can make use of the ForgeAPI for clients and create Sponge plugins for the serverside.
It is even possible to use Sponge on the client-side, but for several tasks mods are still required.</p>
</div>
<div class="section" id="i-m-a-bukkit-plugin-developer-why-can-t-sponge-use-bukkit-s-api">
<h3><a class="toc-backref" href="#id15">I’m a Bukkit Plugin Developer! Why Can’t Sponge Use Bukkit’s API?</a><a class="headerlink" href="#i-m-a-bukkit-plugin-developer-why-can-t-sponge-use-bukkit-s-api" title="Permalink to this headline">¶</a></h3>
<p>Bukkit’s API contains code licensed under the GPL. This is a large reason why Bukkit met its demise in September; by
moving forward with a new API licensed under the MIT license, we can avoid some of the problems that fell upon Bukkit.
While this does not free us from Mojang’s control, as their code is proprietary, it is our belief that Mojang supports
modding and will continue to do so.</p>
</div>
<div class="section" id="will-i-be-able-to-access-the-server-internals-in-my-plugins">
<h3><a class="toc-backref" href="#id16">Will I Be Able to Access the Server Internals In My Plugins?</a><a class="headerlink" href="#will-i-be-able-to-access-the-server-internals-in-my-plugins" title="Permalink to this headline">¶</a></h3>
<p>Accessing the server internals (known as “NMS” or “net.minecraft.server” in CraftBukkit) can be done through Forge,
which has a large number of names de-obfuscated. However, be aware that accessing the server internals raises the risk
of your plugin breaking - this is your prerogative.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2014-2016, Sponge Contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
</div>
</div>
</body>
</html>