docs/content/zh-Hans/docs/manual/tamagotchi/setup-and-use/index.md
对应版本:AIRI-0.10.1-windows-x64-setup
::: warning 阅读前说明
<a id="chapter-1-installation"></a>
找到 Project AIRI GitHub 主页:moeru-ai/airi
建议按下面的步骤操作:
::: tip 下载页面提示
<a id="chapter-2-initial-configuration"></a>
<a id="chapter-2-prerequisites"></a>
在一切正式开始前,你需要首先至少准备一个 LLM 服务提供商的 API。
::: info 名词解释
LLM 是「大型语言模型」(Large Language Model)的缩写。
通俗点讲,一个 AI。
API 全称是应用程序编程接口。
它本质上是一套预先定义好的规则,让不同的软件应用之间可以相互通信、交换数据和功能。
你可以不用去理解他到底是什么,只要会获取就行。 :::
::: tip 获取 API LLM 提供商有很多,而且它们的获取方式各不相同。由于篇幅和时间原因,这里不提供教程或者举例,具体如何获取你可以去网络上搜索或者询问 AI。 :::
::: warning API 安全 获取好 API 后请注意保存好,而且不要告诉其他人! :::
<a id="chapter-2-launch"></a>
::: info 本节示例 下面的步骤以 Deepseek 为例进行演示。 :::
::: tip 关于每次启动的一个可能的bug以及处理办法 每次启动时,您都有可能遇到这样的bug:主界面边框闪烁,点击展开弹出的菜单会很快收回……
如果遇到这个bug,请不要担心,按照如下流程可以解决:(不过你需要足够的手速)
首先,等闪烁的边框熄灭的瞬间点击展开;
快速找到第二行第一个选项“刷新”然后点击即可解决问题。
该bug在最近的几个版本中均未修复,我们会持续向开发者团队反馈这个问题,相信很快它就能得到解决! :::
::: tip 界面翻译说明 「setup with your provider」的意思是「设置您的提供商」。 :::
建议按下面的步骤完成初始配置:
恭喜你,不出意外的话你已经完成了 Airi 的初步配置!
<a id="chapter-3-interface-overview"></a>
<a id="chapter-3-main-window"></a>
该窗口是展示虚拟角色形象的窗口,共有三个选项:
::: info 听力控制补充 打开听力控制好像还需要先打开聊天窗口。由于该功能在编辑者这里暂未成功运行,相关教程暂略。 :::
::: info 名词解释
WebSocket 是一种网络通信协议,提供了浏览器与服务器之间的全双工、持久连接。
简单理解就是传统的 HTTP 是「一问一答」模式(客户端请求,服务器响应,然后断开),
而 WebSocket 建立连接后,双方可以随时互相发送消息,无需重复发起请求。
STT 是「语音转文本」(Speech-to-Text)的缩写,也称自动语音识别(ASR)。
它的目标是让计算机听懂人类的语音,并将其转换成对应的文字。 :::
点击「展开」选项展开后有九个子选项:
<a id="chapter-3-system-tray"></a>
首先,你需要找到 Airi 在任务栏的小图标。
::: tip Windows 任务栏提示 在 Windows 平台,可能需要在任务栏点击「显示隐藏的图标」展开后才能找到 Airi 图标。 :::
右键 Airi 的小图标,你可以看到十个选项:
::: info 名词解释
TTS 是「文本转语音」(Text-to-Speech)的缩写,旨在让计算机将文字自动转换为自然流畅的语音输出。 :::
<a id="chapter-3-settings-overview"></a>
::: info 本节范围 该部分仅介绍界面里有什么,具体功能介绍见第四章。 :::
你可以通过以下两种方式打开设置界面:
设置界面包括以下九大内容:
::: warning 不要打开「窗口快捷方式」 该选项当前没有任何内容,也没有返回键。一旦点进去,就需要「关掉并重新打开设置窗口」才能退出。 :::
<a id="chapter-3-chat-window"></a>
你可以在主窗口点击「展开」,然后选择「打开聊天」来打开聊天窗口。
在这里,你可以和 Airi 聊天。
<a id="chapter-4-settings"></a>
你可以通过以下两种方式打开设置界面:
<a id="chapter-4-airi-card"></a>
在这里,你可以上传、创建或者直接修改默认的角色卡。
::: info 关于上传 从弹出的窗口来看,上传入口疑似支持任意文件类型。但编辑者没有实际使用过,而且角色卡也没有导出功能,因此相关介绍略。 :::
关于创建新角色卡,建议按下面的顺序配置:
其中身份部分最重要的是名字和描述:
::: info 编辑者补充
::: warning 需要手动激活 创建角色卡后默认不会启用,必须手动激活才可以使用。 :::
<a id="chapter-4-modules"></a>
在这里可以配置 Airi 的各种功能,具体如下:
建议按下面的步骤完成配置:
::: tip 服务来源过多时(该内容已得到优化!) 如果可选的服务来源太多,可能点不到位于后面的服务来源。这时候可以把鼠标光标移动到一个选项卡上,按鼠标中键后左右拖动。 :::
::: tip 发声页补充说明
建议按下面的步骤完成配置:
::: tip 服务来源过多时 如果可选的服务来源太多,可能点不到位于后面的服务来源。这时候可以把鼠标光标移动到一个选项卡上,按鼠标中键后左右拖动。 :::
建议按下面的步骤完成配置:
除此之外,你还可以:
::: info 编辑者补充 上面关于「关闭自动发送可以调整转录结果」的说法是编辑者的推测,因为编辑者没有成功调用过听觉功能。 :::
如果你想测试麦克风:
如果你想测试 STT 功能:
::: tip 服务来源过多时 如果可选的服务来源太多,可能点不到位于后面的服务来源。这时候可以把鼠标光标移动到一个选项卡上,按鼠标中键后左右拖动。 :::
建议按下面的步骤完成配置:
::: warning 需要先启用 vision capture 该功能需要先到「系统 → 开发者 → vision capture」处启动,具体介绍见对应部分。 :::
::: tip 服务来源过多时 如果可选的服务来源太多,可能点不到位于后面的服务来源。这时候可以把鼠标光标移动到一个选项卡上,按鼠标中键后左右拖动。 :::
译为:艺术创作。
在这里,你可以为Airi配置艺术创作的能力。
请注意:该功能与neuro的绘画逻辑不同,是借助第三方AI服务进行图片生成——这会让你得到非常精美的由AI生成的图片。
由于时间原因,该部分内容暂不做具体讲解。
功能暂未发布。
功能暂未发布。
在这里你可以配置 Discord 机器人,使 Airi 进入你的 Discord 服务器与人互动。
建议按下面的顺序准备:
::: warning Discord 机器人说明 该功能需要使用 Discord 机器人,目前安装包版本暂未内置,需要你去 GitHub 页面提取相关文件才可以使用。由于编辑者关于这部分内容的日程还很靠后,具体教程暂略。 :::
该功能需要使用机器人才可以使用,具体教程暂略。
该功能需要使用机器人才可以使用,具体教程暂略。
该功能需要使用机器人才可以使用,具体教程暂略。
该功能编辑者没用过,具体教程暂略。
该功能编辑者还在探索当中,具体教程暂略。
<a id="chapter-4-stage"></a>
在这里,你可以配置Airi主界面的场景——你可以简单将其理解为Airi主界面的背景。
这里包含了两个预设,你可以点击其中一个预设中间的对勾(需要将鼠标光标移动上去才会显现)来启用场景。
还可以点击「Upload to Gallery」来导入自己的图片场景。
如果你需要清除场景,请点击「Clear Default」。
<a id="chapter-4-character-model"></a>
在这里你可以选择和设置角色的模型。
Airi 支持的模型包括 Live2D 模型和 VRM 3D 模型。
如果你只是想切换现有模型,建议按下面的步骤操作:
如果你想导入自己的模型,可以点击「add」导入自己的 Live2D 模型或者 VRM 3D 模型。
::: info 编辑者补充 关于「Switch to Godot Stage(Experimental)」选项,由于说明书的主编团队暂未研究明白这个功能且该功能疑似处于实验阶段,相关介绍暂略。 :::
::: warning 导入模型前请注意
你可以继续按下面的顺序调整:
::: info 编辑者补充 该功能编辑者也还没有完整测试,其他相关内容介绍暂略。 :::
你可以先展开「场景」,然后设置 Model Position(译为「模型位置」)、视角调整(度)、相机距离(画面缩放)、模型朝向(Y 轴旋转)、模型注视方向等内容。
::: info 编辑者补充 该部分内容以及下面的「更换模型」介绍因为时间原因暂略。 :::
<a id="chapter-4-memory-bank"></a>
功能暂未发布。
<a id="chapter-4-providers"></a>
在这里,你可以配置 Chat(LLM)、Speech(TTS)、Transcription(STT)、Artistry 的服务来源。
选择一个选项,挑选一种你已经准备好的服务来源,在对应界面填写所需内容即可完成配置。
除此之外,您可以对所有服务做一个筛选,包括Pricing(价格)以及Deployment(部署位置)。
关于Pricing(价格),包括三个选项:
关于Deployment(部署位置),包括三个选项:
::: warning 请注意 部分服务的配置界面可能因为没有得到及时维护而无法正常使用,如果您遇到了类似问题,请在 GitHub 提交 Issue,或者也可以尝试选择「OpenAI 兼容 API」选项进行配置(如果您准备的服务来源支持的话)。 :::
::: info 编辑者补充 该部分具体介绍暂略。 :::
<a id="chapter-4-data"></a>
在这里,你可以管理 Airi 的各种数据。
::: warning 不可恢复操作 该部分可以删除或清理相关数据,而且无法恢复,请谨慎操作。在执行删除和重置操作前,建议先再确认一遍内容。 :::
::: tip 已知问题 「打开 APP 数据文件夹」目前有 Bug,可能会一次性把数据文件夹打开好几次。 :::
建议按方框分区理解:
<a id="chapter-4-connection"></a>
在这里你可以配置你的 WebSocket 服务器地址。
::: info 编辑者补充 具体介绍暂略。 :::
<a id="chapter-4-system"></a>
在这里,你可以设置程序主题、语言等内容。
在这里,你可以更改主题颜色。
::: tip 颜色预设 这里应该点击任意一个圆,而不是点击方框。 :::
::: warning 请勿打开 由于该选项内没有任何内容也没有返回键,一旦点进去就需要「关掉并重新打开设置窗口」,所以请不要点击该选项。 :::
在这里,你可以使用一些高级功能。
::: info 高级功能说明 该部分内容大多为英文,而且属于一般用不到的高级功能,因此下面的介绍仅供参考。 :::
第一个方框及其相关选项:
::: info 编辑者补充 页面当前为空白,介绍暂略。 :::
这里可以检测鼠标光标在电脑屏幕上的位置。
这里可以可视化鼠标光标在电脑屏幕上的位置。
译为「小组件调用」。
译为「上下文流程」。实时检查传入的上下文更新(服务器 + 广播)和传出的聊天钩子。使用此方法验证插件上下文(例如 VSCode 编码上下文)如何传入聊天管道并传出到服务器事件。
这里可以可视化鼠标光标在该窗口上的位置。
译为「节拍同步可视化器」,即同步音律。
即「WebSocket 检查器」。
译为「插件主机调试」。
译为「更新程序」。
具体介绍暂略。
译为「屏幕截图」。
如果你还没有授予系统级的屏幕捕获权限,那么首先会看到下图这样的权限提示窗口。完成授权后,才可以开始捕获任意应用程序窗口或者整个屏幕。
在最上方有四个选项:
译为「视觉捕捉」。
如果还没有授予屏幕捕获权限,这里同样会先显示权限提示。完成授权后,才可以让该页面真正开始捕获画面并查看视觉处理结果。
<a id="chapter-ed-toeveryeditor"></a>
该说明书作为一个主要由非官方人员编写但被提交到官方网站的文档,虽然通常由沐玖芸萱工作室成员负责内容维护,但是我们非常希望所有想编辑该文档或者已经编辑过该文档的朋友能在开头的作者位置留下您的名字,无论您做出的是内容上的改动还是格式上的改动,我们欢迎大家来一同丰富和优化该说明书,为Airi项目、为该说明书贡献一份来自任何人的自己的力量!
另外,如果作为非官方人员的您有改动该说明书的想法,您不需要有任何额外的顾虑,直接改动并提交Pull requests即可。不过再次提醒不要忘记留下您的名字哦!
感谢大家的支持与配合!
—— 凌柃