Silk API
HomeSourcesDownloadCommunitySupport
简体中文(中国大陆)
简体中文(中国大陆)
  • ⭐开始
    • 欢迎来到「丝绸开发库」官方文档!
    • 目录
  • 📂构建项目
    • 了解 Fabric 开发
    • 创建一个 Fabric 项目
    • 为你的项目添加依赖
Powered by GitBook
On this page
  • 添加依赖
  • 设置令牌
  1. 构建项目

为你的项目添加依赖

Last updated 1 year ago

「丝绸开发库」是一个完全托管在 上的项目,所以此项目包是发布在 上的,这意味着你至少需要一个 GitHub 账号。如果没有,你需要。


添加依赖

在添加依赖之前,你需要先在 build.gradle 中添加 Maven 储存库:

repositories {
	maven {
		url = "https://maven.pkg.github.com/silk-mc/silk-api"
		credentials {
			username = System.getenv("GITHUB_ACTOR")
			password = System.getenv("GITHUB_TOKEN")
		}
	}
}

之后,我们再在 build.gradle 中添加「丝绸开发库」依赖:

dependencies {
	modImplementation "pers.saikel0rado1iu:silk-api:${project.silk_version}"
}

最后,我们在 gradle.properties 中设置 ${project.silk_version}

# 将 1.20-0.1.2 替换为想要依赖的「丝绸开发库」版本
silk_version=1.20-0.1.2

设置令牌

在上面我们设置了储存库凭据,这是因为想要使用 GitHub Packages 必须要使用 GitHub 令牌才能进行访问下载。

在创建令牌时,只需要勾选 read:packages 权限

在创建令牌后,一定要记得复制生成的 TOKEN,不然在 TOKEN 关闭后是无法重新查看 TOKEN 的,只能重新生成 TOKEN。

在我们生成了令牌之后,有两种方式去设置令牌:

第一种方式:项目不需要公开,只在私人设备中去编写代码和使用 TOKEN。我们需要修改 build.gradle。(不推荐)

repositories {
	maven {
		url = "https://maven.pkg.github.com/silk-mc/silk-api"
		credentials {
			// 将 username 设置为你的用户名,不是名称。如 username = "Xiao-Ming"
			username = 你的用户名
			// 将 password 设置为你生成的 TOKEN。如 password = "ghp_ABCDEFGabcdefg1234567890"
			password = 你生成的 TOKEN
		}
	}
}

第二种方式:在你的系统里添加 GITHUB_ACTOR 和 GITHUB_TOKEN 两个环境变量,这两个环境变量要与 build.gradle 中储存库凭据对应。

repositories {
	maven {
		url = "https://maven.pkg.github.com/silk-mc/silk-api"
		credentials {
			// "GITHUB_ACTOR" 与环境变量中的 GITHUB_ACTOR 变量名一致
			username = System.getenv("GITHUB_ACTOR")
			// "GITHUB_TOKEN" 与环境变量中的 GITHUB_TOKEN 变量名一致
			password = System.getenv("GITHUB_TOKEN")
		}
	}
}
  • 将 GITHUB_ACTOR 的值设置为你的用户名,注意,不是名称。如 Xiao-Ming

  • 将 GITHUB_TOKEN 设置为你生成的 TOKEN。如 ghp_ABCDEFGabcdefg1234567890

在执行完步骤后,需要重新启动项目并重新构建 Gradle 才能正常识别设置的令牌

至此,「丝绸开发库」依赖添加完毕。

首先,我们需要在 GitHub 中创建一个个人访问令牌,创建令牌可以参考此教程:

📂
GitHub
GitHub Packages
在这里注册一个账号
创建个人访问令牌(经典)