快速上手

欢迎来到 Saltify 的文档！本页面将会通过简单的示例介绍如何快速上手 Saltify。

开始之前

添加 saltify-core 依赖

对于使用 Gradle 的 Kotlin 项目，可以在 build.gradle.kts 中添加以下内容：

dependencies {
    implementation("org.ntqqrev:saltify-core:$saltifyVersion")
    implementation("io.ktor:ktor-client-cio:$ktorVersion")
}

多模块/跨平台配置在这里不多赘述。

配置应用

val client = SaltifyApplication {
    addressBase = "http://localhost:3000"
    accessToken = "your_token"
    
    // 事件服务相关配置
    eventConnection {
        type = EventConnectionType.WebSocket
        autoReconnect = true
    }
}

更多内容请参见 应用配置。请在浏览完本页后一定仔细阅读这一页。

调用 API

// 获取登录信息
val loginInfo = client.getLoginInfo()

// 发送群消息
client.sendGroupMessage(123456789L) {
    text("Hello from Saltify!")
    image("https://example.com/example.jpg")
}

更多 API 请参见项目源码与 IDE 补全。

定义插件

插件是一系列功能的集合，建议将功能逻辑封装在插件中。

val myPlugin = SaltifyPlugin("my-plugin") {
    onStart {
        println("插件已启动")
    }

    on<Event.GroupMemberIncrease> { event ->
        println("新成员加入: ${event.data.userId}")
    }
}

val client = SaltifyApplication {
    // ...

    // 在初始化时安装插件
    install(myPlugin)
    
    // 也可以直接定义插件并安装
    plugin {
        // ...
    }
}

更多内容请参见 插件开发。

定义指令

client.command("say") {
    val content = greedyStringParameter("content", "要重复的内容")

    onExecute {
        respond {
            text(content.value)
        }
    }
}

更多内容请参见 指令开发。