手动创建

欢迎使用 TabooLib！本教程将帮助你创建第一个使用 TabooLib 的插件。

环境准备

在开始之前，请确保你已经安装了以下工具：

必需环境

• JDK 8 或更高版本
• IntelliJ IDEA （推荐）或其他 IDE

创建项目

1. 创建 Gradle 项目

使用 IntelliJ IDEA 创建一个新的 Gradle 项目：

1. File → New → Project
2. 选择 Gradle
3. 语言选择 Kotlin
4. Build System 选择 Gradle

2. 配置 build.gradle.kts

版本信息

构建版本	发行时间	发行者	插件版本

在项目根目录的 build.gradle.kts 文件中添加以下配置：

Kotlin DSL

build.gradle.kts

import io.izzel.taboolib.gradle.*
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
plugins {
    java
    id("io.izzel.taboolib") version "2.0.27" // 上方的 插件版本
    kotlin("jvm") version "2.2.20" // Kotlin 版本
}

taboolib {
    // 选择需要的模块
    env {
        install(Basic, Bukkit, BukkitHook, BukkitNMSUtil)
    }

    // 设置 TabooLib 版本
    version {
        taboolib = "6.2.3-664550e" // 上方的 构建版本
        coroutines = "1.8.1"
    }
}

Groovy DSL

build.gradle

import io.izzel.taboolib.gradle.*

plugins {
    id 'java'
    id 'io.izzel.taboolib' version '2.0.27' // 上方的 插件版本
    id 'org.jetbrains.kotlin.jvm' version '2.2.20' // Kotlin 版本
}

taboolib {
    // 选择需要的模块
    env {
        install(Basic, Bukkit, BukkitHook, BukkitNMSUtil)
    }
    // 设置 TabooLib 版本
    version {
        taboolib = '6.2.3-664550e' // 上方的 构建版本
        coroutines = '1.8.1'
    }
}

3. 添加依赖

添加模块

📦 选择 TabooLib 模块

选择你需要的模块，系统会自动生成配置代码

▶核心模块(1/1)

▶平台模块(0/5)

▶Bukkit 扩展(0/11)

▶数据库(0/8)

▶Minecraft 功能(0/7)

▶脚本引擎(0/2)

📋 生成的配置代码

已选择 1 个模块

taboolib {
            env {
        install(Basic)
    }

    version {
        taboolib = "" // 手动填入最新版本或点击更新按钮
        coroutines = "1.8.1"
    }
}

💡 将以上代码添加到你的 build.gradle.kts 文件中

💡 要使用最新的TabooLib版本哦

添加依赖

build.gradle.kts

dependencies {
    compileOnly(kotlin("stdlib"))
    // highlight-start
    compileOnly("ink.ptms.core:v12004:12004:mapped")
    compileOnly("ink.ptms.core:v12004:12004:universal")
    // highlight-end
}

📚 选择项目依赖

选择你需要的依赖，系统会自动生成配置代码

▼核心文件 - Bukkit(0/1)

两者都包含仅 Universal仅 Mapped

NMS AllcompileOnly

NMS 跨版本工具，用于 NMS 开发

▶核心文件 - BungeeCord(0/1)

▶Gson(0/1)

▶KotlinX(0/2)

▶KotlinX 序列化(0/3)

▶TabooLib 扩展(0/1)

📋 生成的依赖配置

已选择 0 个依赖

// 请先选择依赖或添加 Core 版本

💡 将以上代码添加到你的 build.gradle.kts 文件中

创建插件主类

在 src/main/kotlin 目录下创建你的插件主类：

Kotlin

src/main/kotlin/com/example/ExamplePlugin.kt

package com.example

import taboolib.common.platform.Plugin
import taboolib.common.platform.function.info
import taboolib.platform.BukkitPlugin

object ExamplePlugin : BukkitPlugin() {

    override fun onEnable() {
        info("TabooLib 插件已启动！")
        info("版本: ${description.version}")
    }

    override fun onDisable() {
        info("插件已关闭，再见！")
    }
}

Java

src/main/java/com/example/ExamplePlugin.java

package com.example;

import taboolib.common.platform.Plugin;
import taboolib.common.platform.function.FunctionKt;
import taboolib.platform.BukkitPlugin;

public final class ExamplePlugin extends BukkitPlugin {

    private static ExamplePlugin instance;

    public ExamplePlugin() {
        instance = this;
    }

    @Override
    public void onEnable() {
        FunctionKt.info("TabooLib 插件已启动！");
        FunctionKt.info("版本: " + getDescription().getVersion());
    }

    @Override
    public void onDisable() {
        FunctionKt.info("插件已关闭，再见！");
    }

    public static ExamplePlugin getInstance() {
        return instance;
    }
}

Kotlin 对象

在 Kotlin 中使用 object 声明会自动创建单例，无需手动管理实例。这是推荐的做法！

关于 plugin.yml

默认情况下，你是不需要手动创建的，TabooLib会自动创建。

构建和测试

构建插件

./gradlew clean build

构建完成后，在 build/libs 目录下会生成插件 JAR 文件。

测试插件

1. 将生成的 JAR 文件复制到服务器的 plugins 目录
2. 启动服务器
3. 查看控制台输出

你应该会看到类似这样的日志：

[ExamplePlugin] TabooLib 插件已启动！
[ExamplePlugin] 版本: 1.0.0

恭喜！

你已经成功创建了第一个 TabooLib 插件！🎉

下一步

现在你已经掌握了基础，可以继续学习：

• 命令系统 - 创建强大的命令
• 配置文件 - 管理插件配置
• 语言文件 - 实现多语言支持
• 数据库 - 数据持久化

获取帮助

遇到问题？欢迎加入我们的社区：

• GitHub Issues
• QQ 群
• 文档首页