危险

Adventure 文档目前仍为 尚在施工 状态，并且作为 Javadocs 的补充. 一些地方可能覆盖面有限，或可能不是完全最新的. 所有你有任何问题，欢迎加入我们的 Discord.

SpongeAPI

Adventure 为面向 Minecraft: Java 版 1.12 的 SpongeAPI 7 提供平台. 对于 SpongeAPI 8 以及更高版本 (支持 Minecraft: Java 版 1.16.4), Adventure 是其原生文本依赖库, 无需平台支持.

要想开始使用此平台, 添加这些构件到你的构建文件:

首先, 添加仓库:

<repositories>
    <!-- ... -->
    <repository> <!-- 对于开发构建 -->
      <id>sonatype-oss</id>
      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
    <!-- ... -->
</repositories>

repositories {
   // 对于开发构建
   maven {
       name = "sonatype-oss-snapshots"
       url = "https://oss.sonatype.org/content/repositories/snapshots/"
   }
   // 对于发行版
   mavenCentral()
}

repositories {
   // 对于开发构建
   maven(url = "https://oss.sonatype.org/content/repositories/snapshots/") {
       name = "sonatype-oss-snapshots"
   }
   // 对于发行版
   mavenCentral()
}

声明依赖:

<dependency>
<groupId>net.kyori</groupId>
<artifactId>adventure-platform-spongeapi</artifactId>
<version>4.0.0</version>
</dependency>

dependencies {
   implementation "net.kyori:adventure-platform-spongeapi:4.0.0"
}

dependencies {
   implementation("net.kyori:adventure-platform-spongeapi:4.0.0")
}

用法

SpongeAPI 平台既可以通过 Guice 依赖注入,也可以直接创建. 我们推荐使用注入以减少样板代码.

一个相当直截了当的插件示例:

@Plugin(/* [...] */)
public class MyPlugin {
  private final SpongeAudiences adventure;

  @Inject
  MyPlugin(final SpongeAudiences adventure) {
    this.adventure = adventure;
  }

  public @NonNull SpongeAudiences adventure() {
    return this.adventure;
  }
}

这将会设置一个可以为玩家或者任何 MessageReceiver 提供听众实例的 SpongeAudiences 实例.