==================== Sponge Documentation ==================== .. warning:: This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those. Introduction ============ Welcome to SpongeDocs, the official documentation for the open-source `Sponge `__ project. 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 `here `_. 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 ` or visit their repositories on GitHub: `SpongeForge `_ | `SpongeVanilla `_ | `SpongeAPI `_ | `SpongeDocs `_ | `SpongeHome `_ | `Mixin `_ | `Ore `_ .. note:: Sponge development is ongoing. Beta and Experimental builds of both SpongeForge and SpongeVanilla are currently available for `download `_. 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 the 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 `_ and `YourKit .NET Profiler `_, innovative and intelligent tools for profiling Java and .NET applications. Links ===== .. toctree:: :maxdepth: 2 :titlesonly: - `Sponge Homepage `_ - `Sponge Forums `_ - `Sponge Discord `_ - `Sponge Downloads `_ - `SpongeAPI Issue Tracker `_ - `SpongeAPI Javadocs `_ - `Sponge Twitter `_ - `Sponge Subreddit `_ - `Sponge GitHub `_ - `Sponge Patreon Donation Page `_