<!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>Frequently Asked Questions — 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="../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"/>
<!-- 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="../index.html">
<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 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>
</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="../index.html">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="../index.html">Docs</a> »</li>
<li><a href="index.html">About the Sponge Project</a> »</li>
<li>Frequently Asked Questions</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/minor-fixes-ocd/source/about/faq.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="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 2014;
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 MCP,
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>
<p>See <a class="reference internal" href="../plugin/internals/index.html"><span class="doc">Implementation-dependent Plugins</span></a> for an introduction about using MCP in your plugin.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="structure.html" class="btn btn-neutral float-right" title="The Structure of the Sponge Project" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="introduction.html" class="btn btn-neutral" title="Introduction" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</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/minor-fixes-ocd/source/about/faq.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/minor-fixes-ocd/source/about/faq.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>