Skip to content

01. 引入

H2Sxxa edited this page Dec 4, 2023 · 7 revisions

引入

在本章节里你会知道如何在你的开发环境中引入结界来调用结界的API进行开发

Modrinth Maven

从v1.2.0开始,项目发布到了Modrinth,你可以使用Modrinth Maven,相比Github Package更加快捷方便!

repositories {
    //...
    maven {
        name 'Modrinth'
        url "https://api.modrinth.com/maven"
        content {
            includeGroup 'maven.modrinth'
        }
    }
}

dependencies {
    implementation 'maven.modrinth:kekkai:1.2.0'
}

Github Package(不推荐国内用户使用)

为什么使用Github Package而不是Curse Maven

很多人可能会想,为什么我不把结界上传CurseForge来使开发者使用Curse Maven,原因很简单,CurseForge太难用了(X),然后Github Package又太好用了,于是我为了方便直接使用了Github Package,手动控制Maven的发布。

Github的一些限制

用户认证

Github Package 的使用必须注册 Github ,然后使用 Token 来访问。

注册一个账号后,你需要在 这里 申请一个 Classic 类型的 Token ,我建议你的这个Token仅给予 read:packages 权限,以防万一出现账户安全问题。

Token 不可完整暴露

在上传时,Github 会对你的内容进行检查,如果出现的你的完整 Token ,那么你的 Token 将会失效。

然而如果你需要使用 Github Package ,Token 将不可避免的暴露在 build.gradle 中,那么,该怎么办呢?

方法有很多,我用的方法是将 Token 整个倒序,然后进行 reverse 处理。

例如,你的 Token 是 ghp_12345 ,填写在 build.gradle 中就是 "54321_phg".reverse() ,这样就可绕过 Github 的检查并在项目中使用 Github Package 。

完成引入

打开 build.gradle ,然后参考下面代码相应位置填写。

repositories {
    //...
    maven {
        name 'TGS-Kekkai Github Package'
        url 'https://maven.pkg.github.com/TeamGensouSpark/kekkai'
        credentials {
            username = "Username" //你的用户名
            password = "12345_phg".reverse() //你的 Token ,记得倒序
        }
    }
    //...
}

dependencies {
    //...
    implementation 'io.github.teamgensouspark:kekkai:1.2.0' //把 1.2.0 改为你需要的版本
}

然后重新配置环境就能够成功引入结界了!