Skip to content

Commit

Permalink
Merge pull request #49 from UIGF-org/gitreset
Browse files Browse the repository at this point in the history
refactor: squash sparse commits
  • Loading branch information
Masterain98 authored Jan 20, 2024
2 parents b0efa81 + e0ec7cd commit 3c02489
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
- **`thirdparty`**: 项目代码库的 URL,支持 GitHub、GitLab、Gitee 和其它
- **`version`**:项目所支持的标准及其版本,例如“UIGF v2.3”
- **`preview`**: 项目截图或宣传图的 URL
- 你可以在本项目的 `docs/.vuepress/public/partnerships` 目录下以你的项目名称创建一个文件夹,并上传相关图片资源。 如果你创建的资源路径为 `docs/.vuepress/public/partnerships/sample-project/logo.png`,则其 URL 路径可以写为`https://uigf.org/partnerships/sample-project/logo.png``/partnerships/sample-project/logo.png`
- 我们建议在本项目的 `docs/.vuepress/public/partnerships` 目录下以你的项目名称创建一个文件夹,并上传相关图片资源。 如果你创建的资源路径为 `docs/.vuepress/public/partnerships/sample-project/logo.png`,则其 URL 路径可以写为`https://uigf.org/partnerships/sample-project/logo.png``/partnerships/sample-project/logo.png`

4. 保存你的更改;开启一个 Pull Request 将更改提交到本库的主分支中

- 请在 PR 评论区中上传一份你项目导出的 Json 数据文件作为参考
- 请在 PR 评论区中上传一份你项目导出的 Json 数据文件作为参考
4 changes: 2 additions & 2 deletions docs/zh/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ head:

## 介绍
在统一可交换祈愿记录标准2.3版本中,我们将`item_id`的优先度提高,成为必填的字段。
这将允许 UIGF 数据集支持国际服的多语言环境,进而将更多的原神工具连接在一起。
这将允许 UIGF / SRGF 标准支持国际服的多语言环境,进而将更多的原神工具连接在一起。

但是,一些程序运行于受限的环境中,在将祈愿获取物品名称转化为物品 ID 的过程中有困难。所以 UIGF-Org 提供了一个用于翻译物品文本的 API,
供需要该资源的任何开源程序使用。
Expand Down Expand Up @@ -296,4 +296,4 @@ https://api.uigf.org/dict/starrail/md5.json
"all": "e9e65534e0f64ab56c947df4dd5f353d"
}
```
:::
:::
4 changes: 2 additions & 2 deletions docs/zh/goal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# UIGF-Org 标准的设计初衷

随着米哈游等出品的游戏(如原神)的风靡,越来越多的玩家涉足其中。在这些玩家中,众多对编程充满兴趣的人开始致力于设计游戏辅助工具,以弥补官方工具的不足。然而,个人开发者的资源始终有限。他们通常只能为自己熟悉的平台开发高质量的程序,却无法在其他系统平台上提供同等帮助。这导致玩家不得不在不同工具之间重复配置第三方游戏工具,并重复输入数据。
随着米哈游等出品的游戏(如《原神》)的风靡,越来越多的玩家涉足其中。在这些玩家中,众多对编程充满兴趣的人开始致力于设计游戏辅助工具,以弥补官方工具的不足。然而,个人开发者的资源始终有限。他们通常只能为自己熟悉的平台开发高质量的程序,却无法在其他系统平台上提供同等帮助。这导致玩家不得不在不同工具之间重复配置第三方游戏工具,并重复输入数据。

UIGF-Org 留意到了这个现象。因此,在凝聚开源社区开发者的力量后,我们设计了最初用于原神祈愿数据的统一可交换抽卡记录标准,即 UIGF 标准。采用此标准的应用程序将使用户能够按照 UIGF-Org 定义的数据格式导出其存储的数据,并接受来自其他使用 UIGF-Org 数据格式的应用程序导出的数据。由此,不同应用程序之间的数据障碍将被消除,玩家将以更低的成本在这些第三方应用程序之间切换。

UIGF-Org 设计这些标准的目的是:
1. 允许用户在不同应用程序之间自由切换,而不会受到开发者阻挠,无法导出数据或导出非常规数据格式的限制。
2. 允许用户完全掌控自己的数据,将数据存储于任何值得信赖的存储源。
3. 充分保留用户的游戏数据,通过官方数据源中的 `id`、时间等参数,尽可能确保数据的真实性。
3. 充分保留用户的游戏数据,通过官方数据源中的 `id`、时间等参数,尽可能确保数据的真实性。
2 changes: 1 addition & 1 deletion docs/zh/standards/SRGF.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ head:
::: warning SRGF 标准使用声明
应用必须在同时支持 SRGF 数据格式**导入****导出**功能并在相关功能区域或文档中提供跳转至 [UIGF-Org](https://uigf.org) 的超链接后声明支持 SRGF 格式

仅包含导入功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
仅包含导入或导出功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
:::

## Json 示例
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/standards/UIAF.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ head:
::: warning UIAF 标准使用声明
应用必须在同时支持 UIAF 数据格式**导入****导出**功能并在相关功能区域或文档中提供跳转至 [UIGF-Org](https://uigf.org) 的超链接后声明支持 UIAF 格式

仅包含导入功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
仅包含导入或导出功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
:::

## 前言
Expand All @@ -29,7 +29,7 @@ head:
* [YuehaiTeam/cocogoat](https://github.com/YuehaiTeam/cocogoat)

(上述名称以字典顺序排序,不代表其他任何意义)
在此一起,制定了此项标准,旨在加强各个原神相关的App间的数据可交换性
在此一起,制定了此项标准,旨在加强各个原神相关的App间的成就数据可交换性

## 注意事项

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/standards/UIGF-legacy-v2.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ head:
> Uniformed Interchangeable GachaLog Format standard (UIGF) v2.2 <Badge text="Legacy" type="message" />
::: warning 警告
该标准已过时,[UIGF v2.3](UIGF-legacy-v2.3.md) 替代了本标准。
该标准已过时,[UIGF v2.4](UIGF.md) 替代了本标准。
:::

## 前言
Expand All @@ -29,7 +29,7 @@ head:
* [voderl/genshin gacha analyzer](https://github.com/voderl/genshin-gacha-analyzer)

(上述名称以字典顺序排序,不代表其他任何意义)
在此一起,制定了此项标准,旨在加强各个原神相关的App间的数据可交换性
在此一起,制定了此项标准,旨在加强各个原神相关的App间的祈愿数据可交换性
如果今后出现了新的需要在各App间交换的数据,我们也会进行规范

## 注意事项
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/standards/UIGF-legacy-v2.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ head:
::: warning UIGF 标准使用声明
应用必须在同时支持 UIGF 数据格式**导入****导出**功能并在相关功能区域或文档中提供跳转至 [UIGF-Org](https://uigf.org) 的超链接后声明支持 UIGF 格式

仅包含导入功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
仅包含导入或导出功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
:::
::: warning 警告
该标准已过时,[UIGF v2.4](UIGF.md) 替代了本标准。
Expand Down Expand Up @@ -173,4 +173,4 @@ head:
"title": "UIGF 根对象"
}
}
```
```
4 changes: 2 additions & 2 deletions docs/zh/standards/UIGF.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ head:
::: warning UIGF 标准使用声明
应用必须在同时支持 UIGF 数据格式**导入****导出**功能并在相关功能区域或文档中提供跳转至 [UIGF-Org](https://uigf.org) 的超链接后声明支持 UIGF 格式

仅包含导入功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
仅包含导入或导出功能降低了用户数据可流通性,且将数据至于用户不可控的风险中,不符合 UIGF-Org 设计的初衷。
:::

## 更新记录
Expand Down Expand Up @@ -179,4 +179,4 @@ App 不应假定 `region_time_zone` 的值为上表中给出的值,应具有
"required": ["info", "list"],
"title": "UIGF 根对象"
}
```
```

0 comments on commit 3c02489

Please sign in to comment.