Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions docs/模块拆分.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# windup
本文主要以业务功能为准则,拆分windup模块。

## 用户模块
`提供用户登录登出等场景的模块`

接口:
- 用户登陆(支持邮箱密码登录、邮箱验证码验证、Cookie自动登录、Github或者谷歌登录)
- 用户登出(清除会话存储Cookie)
- 修改密码(通过邮箱验证码验证,进行密码修改)
## 订阅计费模块
`用户通过购买对应的套餐来获得相应的积分数量。系统根据用户调用服务的次数或者产生的会话token数量来对应的执行扣减操作。同时支持用户在线预览积分余量。`

接口:
- 用户订阅(采用积分订阅模式)
- 积分扣减
- 积分余量查询
## 项目模块
`用户想要根据游戏类型如横板游戏、2.5D游戏等来生成对应游戏视角或者风格约束的角色或者专属动作,为统一约束后面生成的角色的视角、风格,故引入项目概念。
项目是组织角色的顶层单位,对应一款游戏或一次 Game Jam,类似工作区,于创建时设定。
记录三项独立信息:题材(如横版动作)、美术风格(如像素)、视角模式(侧视 / 俯视 / 2.5D)。
项目级的风格与视角约束作用于其下所有角色,新建素材默认继承,以保证多角色间的一致性。
视角模式决定角色所需母版数量;题材与风格作为生成约束。
边界:项目内的角色与资产管理为核心能力;同一角色或资产的跨项目复用为后续。`

接口:
- 创建角色项目(约束后面展示节点种类、角色视图效果)
- 展示角色项目列表
- 获取具体项目的详情信息
## 节点模块
`用户在画布上需要搭建具体的节点,如提示词描述节点、生成角色模板节点、生成预设动作如walk节点、idle节点、attack节点或自定义动作节点。
每个节点创建之后,需要提供与名称相匹配的功能。节点与节点之间需要互相传递信息,即连接。具体节点的功能实现可以调用后面AI引擎提供的接口。`

接口:
- 节点创建(提供不同节点类型)
- 节点组装
- 节点查询
- 节点列表查询(种类查询、分页查询)
## 流程库模块
`节点与节点之间组装成工作流程,用户可以通过工作流程库在创建项目中,复用这些节点的组装关系。`

接口:
- 流程查询

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里的接口只有查询和删除,但模块职责要求用户能够保存并在项目中复用节点组装关系。按当前定义,流程库没有任何写入入口,也没有将流程应用到项目的接口,因此实现者无法完成该模块的核心场景。请至少补充流程创建/保存(必要时更新)以及应用/实例化流程的边界。

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

前面节点模块提供了一个组装的接口,即会在对应库中建立节点与节点的相关关系。而流程实际上就是存储节点与节点之间的关系。仅需要提供查询这种节点与节点关系的接口、以及提供一个删除节点与节点关系的接口即可。

- 流程删除
## 审查模块
`系统对外提供逐帧审查、单帧审查的能力。用户可以通过前面UI页面交互,来实际审查相关角色资产。系统内容在创建角色资产的过程中,会有系统审查的流程。`

接口:
- 逐帧审查
- 单帧审查
- 系统质检
## AI引擎模块
`为节点模块提供具体的AI调用功能,如生成角色模版能力、生成相关动作能力、识别角色特征能力、AI审查能力、大语言问答能力。`

接口:
- 生成角色模版
- 生成精灵图集(图生视频方案、图生图方案)
- 识别角色特征
- 大语言模型问答
- AI审查
- quick start模式即通过对话一键完成所有工作

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

大语言模型问答即可一键完成所有工作,后续具体实现细节,也就是在接口实现类中,封装一个可调用工具的列表,即可通过问答交互的形式,调用这些工具来完成生图、人物动作等工作。

## 资产模块
`用户利用本系统创造出的角色资产可以记录在资产模块中。提供查看、添加、删除等功能。`

接口:
- 角色资产列表展示
- 角色资产添加(人物、动作)
- 角色资产详情查询
- 动作资产查询
- 动作资产详情查询
- 角色资产删除(人物、动作)
## 导出模块
`用户在节点工作流程中,生成相关的角色资产,需要导出相应引擎的格式。`

接口:
- 导出GIF格式
- 导出序列帧
- 导出精灵图集
- 导出引擎文件(如Cocos、Unity)