Sponge 开发文档

警告

本文档是针对旧版 SpongeAPI 编写的,目前已不再维护。虽然相应的代码依然能在对应的 API 下工作,但相关政策、方针及链接可能有所变化。请在必要时参阅最新的文档获得相关信息。

简介

欢迎访问 SpongeDocs。这里是开源项目 Sponge 的官方文档。

SpongeAPI 是一个针对 Minecraft 设计的,全新的插件 API。你可以在纯原版的服务器(即 SpongeVanilla)上运行它,也可以在使用 MinecraftForge 的 Mod 服务器(即 SpongeForge)上运行它。你可以在这里下载到运行服务器的相关文件。

还不太确定你需要什么?你可以尝试阅读我们的关于 Sponge 部分。这一部分包含了一段简介,关于 Sponge 项目的常见问题解答,以及一篇关于 Sponge 项目的架构的文章。

服主们可以在创建服务器这一部分阅读我们的一些提示和说明,包括如何安装、运行、和维护一个基于 Sponge 的服务器。

Sponge 项目有若干个主要的组成部分。你可以在这里进一步地了解 Sponge 的项目结构。此外,你也可以访问项目的 GitHub 仓库︰

SpongeForge | SpongeVanilla | SpongeAPI | SpongeDocs | SpongeHome | Mixin | Ore

注解

Sponge 的开发仍在进行中。不过,Beta 和 Experimental 版本的 SpongeForge 和 SpongeVanilla 的构建已经可以在相关下载页面找到了。

内容

创建服务器

该部分内容适合已经拥有或打算创建 Sponge 服务器的用户查看。

为开发作准备

调整好你和你的机器,开始开发你自己的插件,或者协助参与 Sponge 项目本身的开发吧!请在阅读本部分后阅读插件开发向 Sponge 贡献代码两大部分。

插件开发

在使用 SpongeAPI 开发插件的时候需要帮助或者更多的信息?下面的内容会对你有所帮助。

Ore

Ore 是我们提供的插件托管解决方案。在这里你可以找到关于插件发布、安装、管理的资料,以及关于我们的 Web API 的文档。

向 Sponge 贡献代码

如果你想要让 Sponge 变得更好,你可以来看看这些内容。让 Spongie 感到骄傲!

关于 Sponge 项目

这一部分包含了这个项目的一些基本信息,如果你对 Sponge 及其组成部分,还有我们的目标感到困惑,你可以看一看这里。

特别鸣谢

_images/yklogo.png

SpongePowered 团队十分感谢 YourKit 提供功能全面的 Java 性能分析器(Profiler)并将其面向开源项目免费。Yourkit LLC 针对 Java 和 .NET 平台上的应用,开发了相应适用的 YourKit Java ProfilerYourKit .NET Profiler 两款工具。这两款工具在分析 Java 和 .NET 代码方面富于创新并十分智能。