<!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>Ore Plugin Submission Guidelines — 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="Ore Documentation" href="index.html"/> <link rel="next" title="Publishing Your Plugin" href="publish.html"/> <link rel="prev" title="Ore Documentation" href="index.html"/>
<!-- Google Analytics -->
<script>
(function(S,p,o,n,g,i,e){S['GoogleAnalyticsObject']=g;S[g]=S[g]||function(){
(S[g].q=S[g].q||[]).push(arguments)},S[g].l=1*new Date();i=p.createElement(o),
e=p.getElementsByTagName(o)[0];i.async=1;i.src=n;e.parentNode.insertBefore(i,e)
})(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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Ore Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Ore Plugin Submission Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="#projects">Projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="#files">Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="publish.html">Publishing Your Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html">Ore Web API</a></li>
</ul>
</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="../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">Ore Documentation</a> »</li>
<li>Ore Plugin Submission Guidelines</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/fix/https/source/ore/guidelines.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="ore-plugin-submission-guidelines">
<h1>Ore Plugin Submission Guidelines<a class="headerlink" href="#ore-plugin-submission-guidelines" title="Permalink to this headline">¶</a></h1>
<p>Welcome to the Ore submission guidelines. This document provides an outline of our expectations for both project and file submissions.</p>
<p>Remember that these are just guidelines and the Ore team, referred to as the “staff” throughout these guidelines, may choose to allow
or disallow an action that is not explicitly listed here at our own discretion.</p>
</div>
<hr class="docutils" />
<div class="section" id="projects">
<h1>Projects<a class="headerlink" href="#projects" title="Permalink to this headline">¶</a></h1>
<p>Submitted projects should meet the following expectations:</p>
<div class="section" id="name">
<h2>Name<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
<p>Your project’s submitted name should not include a version, tagline, or other description. The name should be unique and original
and must not have a name implying it is a Sponge project (e.g. <em>SpongeWarp</em> is not allowed, <em>Cool Warps for Sponge</em> is).</p>
</div>
<div class="section" id="main-documentation-page-home">
<h2>Main Documentation Page (Home)<a class="headerlink" href="#main-documentation-page-home" title="Permalink to this headline">¶</a></h2>
<p>This is the first page anyone sees when visiting your project. Information here should include a description of your project’s
features. The following, if present in your plugin, should be documented on the main page if not documented elsewhere on the Ore
project: commands, configuration, and permission nodes. Additionally, the below information must be documented on the main page
if relevant:</p>
<blockquote>
<div><p><strong>External Connections</strong></p>
<p>If your project utilizes a web API, phones home to collect data, or otherwise connects to a system external to the server it is
running on, the presence of this feature as well as information on how to enable or disable it must be displayed prominently on
the main page. If your project’s sole purpose involves utilizing an external system (such as a Sponge plugin that translates
chat between languages), a configuration option to toggle making connections to that service is not required. If your plugin
sends information (for example, plugin list or player data), the information collected must be listed on the main page.</p>
<p>Examples of systems that require documentation:</p>
<blockquote>
<div><ul class="simple">
<li>Statistics or usage information collection (‘metrics’)</li>
<li>Geolocation</li>
<li>Translation service</li>
<li>Web server that runs on the plugin, serving information to users</li>
<li>Server that runs on the plugin, listening to requests from other services</li>
<li>IRC/Discord/Telegram/WhatsApp bot or relay</li>
</ul>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="category">
<h2>Category<a class="headerlink" href="#category" title="Permalink to this headline">¶</a></h2>
<p>The category you choose should be accurate. Your project should use the narrowest category possible rather than any category that
slightly applies. If no category appears accurate, the Miscellaneous category should be used.</p>
</div>
<div class="section" id="download-links">
<h2>Download Links<a class="headerlink" href="#download-links" title="Permalink to this headline">¶</a></h2>
<p>Ore provides, on each project page, a download button which will automatically choose the most recent release. If you wish to add
additional download links, all links must point to files hosted on Ore. You may additionally link to unapproved file pages, not
direct file links, on Ore but these links may not be the most prominently displayed links. Further, you may not attempt to
circumvent any plugin warnings on Ore, including warnings that inform the user that a project has not yet been reviewed.</p>
</div>
<div class="section" id="monetization-advertising">
<h2>Monetization / Advertising<a class="headerlink" href="#monetization-advertising" title="Permalink to this headline">¶</a></h2>
<p>Submissions may not be sold, nor may additional features be unlockable with payment. Advertisements and other revenue generating
links (e.g. adfly) are not permitted. The documentation may contain a link to a page to donate to the project maintainer or
other contributors as thanks but that page may not offer additional features or other plugins/mods for sale.</p>
</div>
<div class="section" id="cracked-offline-mode-online-mode-false-support">
<h2>“Cracked” / Offline-mode / online-mode=false Support<a class="headerlink" href="#cracked-offline-mode-online-mode-false-support" title="Permalink to this headline">¶</a></h2>
<p>Projects that explicitly state they are designed for such uses are not allowed. Some projects, such as authentication systems,
may have functionality that can be useful for servers regardless of the server’s use of Mojang authentication, but they may not
promote this additional usage or be specifically designed for servers avoiding Mojang auth. Projects designed for proxies
requiring online-mode=false are allowed, provided they are not written to facilitate circumvention of Minecraft account ownership.</p>
</div>
<div class="section" id="eula">
<h2>EULA<a class="headerlink" href="#eula" title="Permalink to this headline">¶</a></h2>
<p>We aim to comply entirely with the Mojang EULA. Any plugins, services, posts, and/or links suspected of violating the EULA may
be removed at the discretion of the Sponge Staff or at the request of Mojang AB.</p>
</div>
<div class="section" id="forks">
<h2>Forks<a class="headerlink" href="#forks" title="Permalink to this headline">¶</a></h2>
<p>Forks are permitted, provided they meet all items in the below list. Staff have the final say in what constitutes an accepted fork.
Follow the license of the parent project appropriately.</p>
<p>Either:</p>
<blockquote>
<div><ul class="simple">
<li>Contain significant changes warranting the creation of a new project. This is to avoid “I changed the message colors in
Plugin X and now I claim credit!”, or</li>
<li>Continue a plugin that has been abandoned, with proof the author has not been answering messages or has stated the project
will no longer be updated.</li>
</ul>
</div></blockquote>
<p>Acknowledge or credit the past plugin and developers. Essentially, don’t claim it is a new plugin and exclusively your creation.</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="files">
<h1>Files<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h1>
<p>Files submitted should meet the following expectations:</p>
<div class="section" id="obfuscation">
<h2>Obfuscation<a class="headerlink" href="#obfuscation" title="Permalink to this headline">¶</a></h2>
<p>A file that utilizes obfuscation will be denied unless it falls under the following exception:</p>
<blockquote>
<div><p><strong>NMS Obfuscation</strong></p>
<p>This only applies for plugins which reference Minecraft or a Forge mod. Examples would be a plugin using Mixins or a plugin
which doubles as a Forge mod (hybrid plugin). Provided that the only obfuscated references are to obfuscated source generated
using ForgeGradle or VanillaGradle, the plugin is allowed to proceed through the review process.</p>
</div></blockquote>
</div>
<div class="section" id="core-mods-and-mixins-modification-of-the-minecraft-base-code">
<h2>Core Mods and Mixins: Modification of the Minecraft Base Code<a class="headerlink" href="#core-mods-and-mixins-modification-of-the-minecraft-base-code" title="Permalink to this headline">¶</a></h2>
<p>Plugins and mods that use a system that modifies the Minecraft base code at runtime, (such as core mods and mixins) must disclose
the edits that they make to the Minecraft code, and their reasoning for them. Sponge plugins should use the Sponge API where
possible. Sponge implementations may implement technical restrictions to prevent such modifications from being applied by default.
Files are not permitted to attempt to work around these restrictions, but can notify the user that enhanced functionality can be
enabled via the Sponge provided configuration options.</p>
</div>
<div class="section" id="external-connections-web-api-phoning-home-etc">
<h2>External Connections (Web API, Phoning Home, etc.)<a class="headerlink" href="#external-connections-web-api-phoning-home-etc" title="Permalink to this headline">¶</a></h2>
<p>Many great features can be written by making calls to external systems. As well as being clearly documented in project descriptions,
such functionality should be configurable and disabled by default. If your project’s sole purpose involves utilizing an external
system (such as a Sponge plugin that translates chat between languages), connecting to that system does not need to be disableable.
If your plugin sends information (e.g. a plugin list, player data, or map data) to external systems, the information collected
must be listed on the main page (see above).</p>
</div>
<div class="section" id="execution-of-downloaded-code">
<h2>Execution of Downloaded Code<a class="headerlink" href="#execution-of-downloaded-code" title="Permalink to this headline">¶</a></h2>
<p>This is a security risk we will not tolerate. This includes downloading jar or class files, generation of bytecode from downloaded
sources, and execution shell scripts.</p>
</div>
<div class="section" id="id1">
<h2>Monetization / Advertising<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>All functionality present in your plugin should be usable without restriction, and can not require a license key to operate.
External APIs, such as translation or geolocation services, that require payment for functionality can be allowed but must be
discussed among staff prior to approval. Plugins may not be used to display advertisements.</p>
</div>
<div class="section" id="update-checking">
<h2>Update Checking<a class="headerlink" href="#update-checking" title="Permalink to this headline">¶</a></h2>
<p>Checking for updates should be performed using the provided Ore API. Your plugin may not link anywhere but Ore when directing
users of your plugin to download new versions. Note that this update checking counts as an external connection, which must be
documented and for which configuration must exist to disable it.</p>
</div>
<div class="section" id="privilege-granting">
<h2>Privilege Granting<a class="headerlink" href="#privilege-granting" title="Permalink to this headline">¶</a></h2>
<p>Plugins must not grant or revoke feature access to any particular user or group of users determined by the plugin developer.
This includes the author granting themselves a special display name or letting themselves use a special command. Features,
when applicable, should be locked behind permission nodes, rather than access being predetermined by the author. Commands
for granting specific, pre-programmed users OP or permissions are not acceptable.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="publish.html" class="btn btn-neutral float-right" title="Publishing Your Plugin" accesskey="n" rel="next">Next <span class="fa fa-angle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Ore Documentation" accesskey="p" rel="prev"><span class="fa fa-angle-left"></span> Previous</a>
</div>
<hr/>
<section id="license">
<p>Except where otherwise noted,
<a xmlns:dct="http://purl.org/dc/terms/" xmlns:cc="http://creativecommons.org/ns#" property="dct:title" rel="cc:attributionURL" href="https://github.com/SpongePowered/SpongeDocs">SpongeDocs</a>
is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
</p>
<a id="license-icons" rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/" title="CC-BY-SA" aria-hidden="true">cba</a>
</section>
</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/fix/https/source/ore/guidelines.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/fix/https/source/ore/guidelines.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>