快速上手#

该章节将会简单描述如何安装 KookyBot SDK 并编写、运行一个简单的机器人。

您也可以参考 Kotlin 示例代码仓库或者 Java 示例代码仓库来帮助您快速上手。

添加依赖#

我们在此处将会演示如何使用 jitpack 搭配 Gradle/Maven 等工具来添加 KookyBot SDK 作为项目依赖。

添加 Mojang 仓库

KookyBot 使用 Mojang Brigadier 作为命令解析器，所以您需要添加 Mojang 的依赖仓库来让 KookyBot 的命令机制正常工作

repositories {
   ...
   maven { url = uri("https://libraries.minecraft.net") }
}

repositories {
   ...
   maven { url 'https://libraries.minecraft.net' }
}

<repositories>
   <repository>
      <id>mclib</id>
      <url>https://libraries.minecraft.net</url>
   </repository>
</repositories>

添加 JitPack 作为依赖仓库

KookyBot 目前使用 jitpack 作为依赖仓库，所以您需要添加 jitpack 来让 Gradle/Maven 可以正常获取 KookyBot

repositories {
   ...
   maven { url = uri("https://jitpack.io") }
}

repositories {
   ...
   maven { url 'https://jitpack.io' }
}

<repositories>
   <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
   </repository>
</repositories>

添加 slf4j 到依赖中

KookyBot 使用 slf4j 作为 LOG 库，所以您需要添加 slf4j 到依赖中

dependencies {
   ...
   // Logging Framework
   implementation("org.slf4j:slf4j-simple:1.7.11")
}

dependencies {
   ...
   // Logging Framework
   implementation 'org.slf4j:slf4j-simple:1.7.11'
}

<dependencies>
   <!-- Logging Framework -->
   <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-simple</artifactId>
      <version>1.7.11</version>
   </dependency>
</dependencies>

添加 KookyBot 到依赖中

备注

注意，假如您希望使用实验版或者指定 commit 构建

请将版本 tag（下文中的 0.2.1）改为 master-SNAPSHOT（基于主分支最新 commit 的构建）或者 commit 哈希

dependencies {
   ...
   // KOOK SDK
   implementation("com.github.KookyBot:KookyBot:0.2.1")
}

dependencies {
   ...
   // KOOK SDK
   implementation 'com.github.KookyBot:KookyBot:0.2.1'
}

<dependencies>
   <!-- KOOK SDK -->
   <dependency>
      <groupId>com.github.KookyBot</groupId>
      <artifactId>KookyBot</artifactId>
      <version>0.2.1</version>
   </dependency>
</dependencies>

现在 KookyBot SDK 已经添加到您的项目中，您可以开始使用本 SDK 开发了！

编写你的第一行代码#

现在，KookyBot SDK 已经添加到您的项目中，您可以开始使用本 SDK 开发了！在合适的地方创建 Application.kt或者 Main.java文件，然后在这个文件中开发你的第一个 KookyBot 机器人。

Kotlin 示例代码

Java 示例代码

// The "io.github.kookybot" here should be replace by your own package name
// 此处的 "io.github.kookybot" 应该替换为您的包名
package io.github.kookybot

import java.io.File
import io.github.kookybot.client.Client
import io.github.kookybot.events.channel.ChannelMessageEvent

suspend fun main() {
   // Read the KOOK bot token / 读取 KOOK bot token
   val token = File("data/token.txt").readLines().first()
   // Create a new KOOK bot client / 创建一个新的 KOOK bot 客户端
   val client = Client(token) {
      // Register default Brigadier commands / 注册默认 Brigadier 命令
      withDefaultCommands()
   }
   // Start the KOOK bot client / 启动 KOOK bot 客户端
   val self = client.start()
   // Add a listener for channel messages / 添加一个监听器以侦听频道消息
   client.eventManager.addListener<ChannelMessageEvent> {
      // Message is "hello" / 消息是 "hello"
      if (content == "hello") {
            // Send "Hello, world!" to the channel / 发送 "Hello, world!" 到频道
            channel.sendMessage("Hello, world!")
      }
   }
}

// The "io.github.kookybot" here should be replace by your own package name
// 此处的 "io.github.kookybot" 应该替换为您的包名
package io.github.kookybot;

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.util.StringTokenizer;

import io.github.kookybot.client.Client;
import io.github.kookybot.contract.Self;
import io.github.kookybot.events.EventHandler;
import io.github.kookybot.events.Listener;
import io.github.kookybot.events.channel.ChannelMessageEvent;

public class Main {
   // Channel Message Listener / 频道消息监听器
   public static class ChannelMessageListener implements Listener {
      @SuppressWarnings("unused")
      @EventHandler
      // Received Channel Message Event / 收到频道消息事件
      public void onChannelMessage(ChannelMessageEvent event) {
            // Add a listener for channel messages / 添加一个监听器以侦听频道消息
            if (event.getContent().equals("hello")) {
               // Send "Hello, world!" to the channel / 发送 "Hello, world!" 到频道
               event.getChannel().sendMessage("Hello, world!", null);
            }
      }
   }

   public static void main(String[] args) throws IOException {
      // Read the KOOK bot token / 读取 KOOK bot token
      String token = new StringTokenizer(
               new BufferedReader(
                        new FileReader("data/token.txt")
               ).readLine()
      ).nextToken();
      // Create a new KOOK bot client / 创建一个新的 KOOK bot 客户端
      Client client = new Client(token, configure -> {
            // Register default Brigadier commands / 注册默认 Brigadier 命令
            configure.withDefaultCommands();
            return null;
      });
      // Start the KOOK bot client / 启动 KOOK bot 客户端
      @SuppressWarnings("unused")
      Self self = JavaBaseClass.utils.connectWebsocket(client);
      // Add a listener for channel messages / 添加一个监听器以侦听频道消息
      client.getEventManager().addClassListener(new ChannelMessageListener());
   }
}

现在，将机器人邀请到您的服务器中，并在频道中发送 hello 试试看！您也可以发送 /help 命令来获取默认命令帮助。