# Desktop-Pet-Godot

**Repository Path**: jihen/Desktop-Pet-Godot

## Basic Information

- **Project Name**: Desktop-Pet-Godot
- **Description**: 🤖👾🐶一款由大语言模型驱动、Godot 制作的 AI 桌宠，旨在提供一个全能的、丰富的桌面AI宠物。An AI desktop pet created with Godot and powered by LLM, designed to offer a versatile and enriched desktop AI companion.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2024-09-04
- **Last Updated**: 2025-10-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">🐶 Godog 🐶</h1>
<h2 align="center">AI Godot 桌宠</h2>

简体中文 /  [English](README_EN.md)

## 👋 介绍

**项目在github上同名，更新更快。**

🚀 🚀 🚀 一款由大语言模型驱动、Godot 制作的 AI 桌宠，旨在提供一个全能的、丰富的桌面AI宠物。你可以将其作为基础，构建你自己独特的桌宠形象和角色行为

- 使用Godot：轻量、开发简单
- 兼容大量的大语言模型
- 有预制角色功能，多种形象
- 支持多模态
- 在此基础上，方便构建自己的 AI 桌宠

![](/img/example.png)

![](assets/themes.png)

## 📙 使用手册

### ⬇️ 安装

下载地址：查看 `release`

### 🔑 使用
1. 点击 `编辑预设`，填写名称，API Key，点击 **保存(修改)**
2. 点击 `存储预设`，选中刚刚添加的预设
3. 开始对话

> [!Caution]
> 当前仅支持 OpenAI 的视觉能力(VISION)，建议使用 **gpt-4o** 模型
> 你可以使用其他模型，但不支持多模态

### ⌨️ 快捷键
- **鼠标右键** 角色区域弹出对话框
- 当焦点在角色窗口上，按  **ESC** 关闭软件 

## 🚦开发计划

- [ ] 添加多语言的支持
- [ ] 添加更多个性化角色的动画，机制，事件
- [ ] 添加更多模型支持
- [ ] 添加对话框对 markdown 语法渲染的支持
- [ ] 添加语音、文件上传等多模态的能力
- [ ] 添加更多的预设
- [ ] 添加更多角色主题设置，方便导入

## 🐶 开发自己的桌宠

基于 Godot 的轻便和易学，你可以很容易构建独属于你自己的桌面宠物形象。

### 🐾 步骤

1. 准备一套角色帧动： 你可以查看[itch.ion](https://itch.io/game-assets)等，选择一套自己喜欢的下载，**注意版权，仅自己用不用太注意**。
2. Godot！启动！[下载](https://godotengine.org/download/windows/)
3. 查看并学习官方文档：不需要害怕，Godot很简单，查看[Animation](https://docs.godotengine.org/en/4.2/tutorials/animation/index.html)。
4. 开发（continue...）


5. [导出](https://docs.godotengine.org/zh-cn/4.x/tutorials/export/index.html)

### 🏗️ 项目架构

```css
- root(Window)
  - Globals(Node)
  - App(Node)
	- Canvas(Node2D) - 角色部分
	  - Grapic(Node2D) - 显示区域 和 角色管理
	  - Dialogue(Control) - 对话显示
	- Send(Window) - 发送消息
	  - TabContainer(TabContainer)
		- 对话栏(Control)
		- 存储预设(Control)
		- 编辑预设(Control)
		  - Model(PanelContainer)
		  - Parament(PanelContainer)
```

### 🔊 注意

> [!Caution]
> 1. 开发使用的godot版本号为 4.3 stable，Godot4 应该都是可以的(未测试) 
> 2. 导入角色素材记得合适的缩放，同时不忘了调整 显示区域(ClickPolygon) 的大小
> 3. Godot右上角 选择**兼容模式**

## 🤝 贡献


项目目前处于开发阶段，还存在许多 Bug，我正着手修复。
欢迎任何贡献，即使细微。
添加角色素材等等

## ©️ 版权和授权

你可以使用项目中的任何代码片段，但不能直接将完整项目打包用于商业项目。
同时，需要注意项目中使用到的一些资产的版权信息。


## ❤️ 鸣谢

多亏了如下开源的项目和精彩绝伦的资产，才有了该项目：

- [ChatGPT-stream-for-Godot-4](https://github.com/oceanbuilders/ChatGPT-stream-for-Godot-4) - stream输出的支持
- [godot-click-through-transparent-window](https://github.com/atadenizoktay/godot-click-through-transparent-window) - 透明窗口
- [tech-dungeon-roguelite](https://trevor-pupkin.itch.io/tech-dungeon-roguelite) - 角色资产
- [tiny-swords](https://pixelfrog-assets.itch.io/tiny-swords) - 角色资产
- [dino-characters](https://arks.itch.io/dino-characters) - 角色资产
- [VPet](https://github.com/LorisYounger/VPet) - 角色资产