@dchighs/dc-配置
⚠️ 说明:不要问我如何获得你的URL,Auth Token,或用户ID;我不会回答你. 如果你不知道如何使用这个, 是因为你不应该.
@dchighs/dc-配置 是用于访问游戏配置数据的软件包 龙城 (这不是官方SocialPoint图书馆,是粉丝制作的).
* 安装
安装是直截了当的 – 简单使用您的首选软件包管理器 。 以下是利用国家预防机制的例子:
npm i @dchighs/dc-config
使用量
获取特定参数的配置
创建 Config 例如,您需要提供证书或使用静态 .create() 提供必要的参数:
import { Config, ConfigLanguage, ConfigPlatform, ConfigFilter } from "@dchighs/dc-config"
;(async () => {
const userId = process.env.USER_ID
const authToken = process.env.AUTH_TOKEN
const url = process.env.URL
const config = await Config.create({
url: url,
userId: userId,
authToken: authToken,
language: ConfigLanguage.Turkish, // optional - "en" is default
platform: ConfigPlatform.Android, // optional - "ios" is default
filter: [ConfigFilter.Items] // optional - undefined is default
})
const data = config.data
console.log(data)
})();
从文件中装入已保存的配置
如果您有保存的包含配置数据的JSON文件,并想加载它以使用类来进行操作,您可以按以下方式完成: 1
import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/dc-config"
import fs from "node:fs"
;(async () => {
const filePath = "config.json"
const contentString = await fs.promises.readFile(filePath, { encoding: "utf-8" })
const data = JSON.parse(contentString) as GameConfigDto
const config = new Config({
language: ConfigLanguage.Turkish,
platform: ConfigPlatform.Android,
data: data
})
})();
从 URL 获取原始配置
如果您有完整的原始 JSON 文件并想要取回并过滤特定密钥 :
import { Config, ConfigFilter, ConfigLanguage } from "@dchighs/dc-config"
;(async () => {
const rawUrl = "https://example.com/config.json"
// Using createRaw to get a Config instance
const config = await Config.createRaw({
url: rawUrl,
filter: [ConfigFilter.Items],
language: ConfigLanguage.English
})
// Or using fetchRaw to get just the data (GameConfigDto)
const data = await Config.fetchRaw({
url: rawUrl,
filter: [ConfigFilter.Items]
})
})();
捐款
- 想贡献吗? 遵循这些步骤:
- 叉出宝库.
- 创建新分支( N)
git checkout -b feature-new) (中文(简体) ). - 提交更改( E)
git commit -m 'Add new feature') (中文(简体) ). - 推向分行(
git push origin feature-new) (中文(简体) ). - 打开拉出请求.
许可证
这个项目根据麻省理工学院的许可证获得许可.