====================
Sponge Documentation
====================

Introduction
============

Welcome to SpongeDocs, the official documentation for the open-source `Sponge <https://www.spongepowered.org>`__ project.

SpongeAPI is your all new plugin API for Minecraft: Java Edition. You can run it on a plain vanilla server (as
SpongeVanilla) or on your fully modded MinecraftForge server (as SpongeForge). Grab your copy
`here <https://www.spongepowered.org/downloads>`_.

Not sure what you're looking for? Try our :doc:`about/index` section, which contains a short :doc:`about/introduction`,
our :doc:`about/faq` and an article about :doc:`about/structure`.

Server owners should read our tips and instructions in :doc:`server/index` on how to install, run and maintain a Sponge
based server.


The Sponge project has several main components. Learn more about the project structure :doc:`here <about/structure>`
or visit their repositories on GitHub:

`SpongeForge <https://github.com/spongepowered/spongeforge>`_ |
`SpongeVanilla <https://github.com/spongepowered/spongevanilla>`_ | `SpongeAPI <https://github.com/spongepowered/spongeapi>`_ |
`SpongeDocs <https://github.com/spongepowered/spongedocs>`_ | `SpongeHome <https://github.com/SpongePowered/SpongeHome>`_ |
`Mixin <https://github.com/SpongePowered/Mixin>`_ |  `Ore <https://github.com/SpongePowered/Ore>`_

.. note::

    Sponge development is ongoing. Beta and Experimental builds of both SpongeForge and SpongeVanilla are currently
    available for `download <https://www.spongepowered.org/downloads>`_.

Contents
========

Creating a Server
~~~~~~~~~~~~~~~~~

This section is for users who have a Sponge server or are interested in creating one.

.. toctree::
    :maxdepth: 2
    :titlesonly:

    server/index

Preparing for Development
~~~~~~~~~~~~~~~~~~~~~~~~~

Get yourself and your machine ready to develop Sponge itself or your own plugins! Please read this section before
:doc:`plugin/index` and :doc:`contributing/index`.

.. toctree::
    :maxdepth: 2
    :titlesonly:

    preparing/index

Creating Plugins
~~~~~~~~~~~~~~~~

Need help and information while coding your plugin for SpongeAPI? Look no further!

.. toctree::
    :maxdepth: 2
    :titlesonly:

    plugin/index

Ore
~~~

Learn how to publish, install, browse, and use our Web API for our custom built plugin hosting solution, Ore.

.. toctree::
    :maxdepth: 2
    :titlesonly:

    ore/index

Contributing to Sponge
~~~~~~~~~~~~~~~~~~~~~~

Look here if you want to help out in making Sponge better. Make Spongie proud!

.. toctree::
    :maxdepth: 2
    :titlesonly:

    contributing/index

About Sponge
~~~~~~~~~~~~

This section contains basic information about the project, read this if you're confused about Sponge, its parts, or our
goals.

.. toctree::
    :maxdepth: 3
    :titlesonly:

    about/index

Acknowledgements
~~~~~~~~~~~~~~~~

.. image:: /images/yklogo.png

The SpongePowered team are grateful to *YourKit* for providing its full-featured Java Profiler free to open source
projects. YourKit, LLC is the creator of `YourKit Java Profiler <https://www.yourkit.com/java/profiler/index.jsp>`_
and `YourKit .NET Profiler <https://www.yourkit.com/.net/profiler/index.jsp>`_, innovative and intelligent tools
for profiling Java and .NET applications.



Links
=====

.. toctree::
    :maxdepth: 2
    :titlesonly:

-  `Sponge Homepage <https://www.spongepowered.org>`_
-  `Sponge Forums <https://forums.spongepowered.org>`_
-  `Sponge Discord <https://discord.gg/PtaGRAs>`_
-  `Sponge Downloads <https://www.spongepowered.org/downloads>`_
-  `SpongeAPI Issue Tracker <https://github.com/SpongePowered/SpongeAPI/issues?q=>`_
-  `SpongeAPI Javadocs <https://jd.spongepowered.org>`_
-  `Sponge Twitter <https://twitter.com/SpongePowered>`_
-  `Sponge Subreddit <https://www.reddit.com/r/spongeproject>`_
-  `Sponge GitHub <https://github.com/SpongePowered>`_
-  `Sponge Patreon Donation Page <https://www.patreon.com/Sponge>`_