Awesome

Author: 目棃 Description: 说明文档 Date: 2023-03-05 Update: 2024-11-19

本文档 Frontmatter 由 MuCli 自动生成于 2023-03-05 14:41:55

更新于 2024-11-19 17:06:18

Teyvat Guide

基于 Tauri 的原神工具应用，支持 Windows 和 macOS 平台。

Game Tool for Genshin Impact player, supports Windows and macOS.

下载 / Download

程序已经通过微软商店审核，可以直接在商店下载。

macOS 用户可以通过 Github Release 下载，可能需要额外操作以打开。

macOS users could download the app from GitHub release, extra steps are needed to open the app.

仓库概况 / Repo Stats

功能 / Features

• 免登陆功能：

  • 当前卡池、近期活动、素材日历
  • 游戏内公告&活动获取
  • 米游社官方帖获取（支持通过 ID 获取）
  • 米游社各分区帖子获取（支持通过 ID 获取）
  • 米游社话题帖子获取（通过话题点击跳转）
  • 成就管理（UIAF v1.1），支持 YaeAchievement 导入
  • 祈愿管理（UIGF v3.0，UIGF v4.0）
  • 留影叙佳期画片查看
  • 帖子收藏
  • 帖子评论查看&分享

• 登陆功能：

  • 原神战绩数据获取
  • 角色详情数据获取
  • 螺旋深渊数据获取
  • 真境剧诗数据获取
  • 祈愿数据获取（近一年）
  • 用户收藏帖子获取

• Wiki 功能：

  • 深渊数据库（Hutao API）
  • 角色图鉴
  • 武器图鉴
  • 名片图鉴
  • 材料图鉴

• 应用功能：

  • 浅色/深色主题切换
  • 米游社 JSBridge

贡献者 / Contributors

• BTMuli
• 舰队的偶像岛风酱！
• jerry765
• AuroraZiling

UI 参考 / UI Reference

• Snap.Hutao
• Starward
• 米游社
• 原神

相关文档 / Docs

• Changelog: CHANGELOG
• 资源来源：项目资源说明
• UIAF：UIAF v1.1
• UIGF：UIGF v3.0，UIGF v4.0
• macOS 平台门禁属性导致应用无法打开应用的修复指引

特定项目 / Special Project

• MuCli：基于 NodeJS 的命令行工具，用于生成项目文档。
• TGAssistant：Teyvat Guide 的资源获取、解析、处理仓库。
• WhiteTea：Github Bot，（半）自动化处理 Teyvat Guide 的 Issue 和 Pull Request。

技术栈 / Tech Stack

• Tauri
• Vue3
• Vite
• Vuetify

第三方组件 / Plugins

• Ajv：用于校验UIAF&UIGF导入数据
• Artplayer：用于米游社帖子视频播放解析
• Echarts：用于祈愿概览图生成
• Html2Canvas：用于分享图生成

协议 / License

项目基于 MIT 协议开源。

应用版本号遵循 Semantic Versioning 2.0.0 规范。

隐私政策：Privacy

鸣谢 / Thanks

本项目在开发过程中参考了诸多相关开源项目，特此鸣谢。

• UIGF Organization
• Snap.Hutao
• StarWard
• xunkong
• gs-helper
• paimon-moe
• Adachi-BOT
• amos-data

感谢 JetBrains 提供的开源许可证。