# UIGF

# UIGF-Org Website

[简体中文] [English]

这是 UIGF-Org 网站的代码储存库。你可以访问 [URL Redacted] 以查看实时版本

## 本地测试

### 第一次安装

- 安装 NodeJS 18
- 使用 GitHub Desktop 或者 Git 命令行来克隆本库 ( `git clone` )
- 在 项目根目录 运行 `npm install` 命令

### 本地测试

- 在 项目根目录 运行 `npm run docs:dev` 命令
  - 站点会默认运行在 `http://localhost:8080`

## 如何在主页中添加你的项目

1. 请确保您的项目对于对应标准具有完整的导入与导出支持，能够正确导出可通过验证的该标准格式文件，能够正确导入可通过验证的、仅具有必要字段的该标准格式文件。

2. 克隆这个库

3. 在 `docs/en/` 和 `docs/zh/` 目录下，找到 `partnership-list.md`

4. 在正确的标准区域中，复制以下代码并填入你项目的信息

        <Pcd
          bg=""
          icon=""
          repo=""
          site=""
          title=""
          desc=""
          import export>
          <template #import>
            <Pcb label="UIGF vx.x" :games="['ys', 'sr', 'zzz_']" bg=""></Pcb>
            <Pcb bg="">Text</Pcb>
          </template>
          <template #export>
            <Pcb label="UIGF vx.x" :games="['ys', 'sr', 'zzz_']" bg=""></Pcb>
            <Pcb bg="">Text</Pcb>
          </template>
        </Pcd>

   - 字段解释
     - `bg` : 项目截图或宣传图的 URL
     - `icon` : 项目图标的 URL
     - `repo` : 项目代码库的 URL
     - `site` : 项目主页的 URL

   - 示例代码：

         <!-- 项目支持UIGFv2.4~4.0的导入，但仅支持UIGF3.0 4.0的导出 -->
         <Pcd
           bg="/partnerships/TeyvatGuide/AppPreview.png"
           icon="/partnerships/TeyvatGuide/logo.png"
           repo=""
           site=""
           title="提瓦特指南"
           desc="Game Tool for Genshin Impact Player"
           import export>
           <template #import>
             <Pcb label="UIGF v4.0" :games="['ys', 'sr_', 'zzz_']" bg="orange"></Pcb>
             <Pcb label="UIGF v3.0" :games="['ys']" bg="white"></Pcb>
             <Pcb label="UIGF v2.4" :games="['ys']" bg="white"></Pcb>
             <Pcb label="UIGF v2.3" :games="['ys']" bg="white"></Pcb>
           </template>
           <template #export>
             <Pcb label="UIGF v4.0" :games="['ys', 'sr_', 'zzz_']" bg="orange"></Pcb>
             <Pcb label="UIGF v3.0" :games="['ys']" bg="white"></Pcb>
           </template>
         </Pcd>

   - 若您的项目
     - 支持 UIGF v4.0或以上版本
     - 已经是UIGF v3.0或以下版本 或 SRGF的认证合作项目
     - 仍然保留对UIGF v3.0或以下版本 或 SRGF的完整支持

     请仅将您的项目置于“使用 UIGF (v4.0 或以上) 标准的项目”区域中，并添加对应旧有认证版本的 标签。该标签的背景颜色建议选择`white`。

   - 我们建议在本项目的 `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`