@guoquan.net/flow-engine 0.1.9 → 0.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
[](https://github.com/guoquan/flow-engine/actions/workflows/ci.yml)
|
|
5
5
|
[](https://codecov.io/gh/guoquan/flow-engine)
|
|
6
6
|
[](https://github.com/guoquan/flow-engine/actions/workflows/deploy.yml)
|
|
7
|
+
[](https://www.npmjs.com/package/@guoquan.net/flow-engine)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
9
|
|
|
8
10
|
[English](#english) | [中文](#中文)
|
|
9
11
|
|
|
@@ -13,36 +15,54 @@
|
|
|
13
15
|
|
|
14
16
|
> **"Flow: Convincing at first breath."**
|
|
15
17
|
|
|
16
|
-
**Flow**
|
|
17
|
-
|
|
18
|
-
### 🌟 Highlights
|
|
19
|
-
- **Modern Rendering**: Based on WebGPU for next-gen performance and visual quality.
|
|
20
|
-
- **Data-Driven**: Animation and behavior fully controlled via JSON configuration.
|
|
21
|
-
- **Zero-Dependency Core**: Pure frontend architecture, easy to integrate into any project.
|
|
22
|
-
|
|
23
|
-
### 🛠 Tech Stack
|
|
24
|
-
- **Core**: TypeScript
|
|
25
|
-
- **Rendering**: Three.js (WebGPU Renderer)
|
|
26
|
-
- **Build**: Vite
|
|
18
|
+
**Flow** is a high-performance, lightweight web-based digital human engine based on WebGPU.
|
|
27
19
|
|
|
28
20
|
### 📦 Installation
|
|
29
21
|
|
|
30
|
-
|
|
22
|
+
This package is distributed under two different scopes depending on the registry:
|
|
31
23
|
|
|
24
|
+
#### Stable Versions (Recommended)
|
|
25
|
+
|
|
26
|
+
**From NPM Registry:**
|
|
32
27
|
```bash
|
|
33
|
-
|
|
34
|
-
|
|
28
|
+
npm install @guoquan.net/flow-engine
|
|
29
|
+
```
|
|
35
30
|
|
|
36
|
-
|
|
37
|
-
|
|
31
|
+
**From GitHub Packages Registry:**
|
|
32
|
+
Add a `.npmrc` file to your project:
|
|
33
|
+
```ini
|
|
34
|
+
@guoquan:registry=https://npm.pkg.github.com
|
|
35
|
+
```
|
|
36
|
+
Then install:
|
|
37
|
+
```bash
|
|
38
|
+
npm install @guoquan/flow-engine
|
|
38
39
|
```
|
|
39
40
|
|
|
40
|
-
|
|
41
|
+
> **Note**: The naming difference (`@guoquan.net` on NPM vs `@guoquan` on GitHub) is due to account scope requirements on each platform.
|
|
42
|
+
|
|
43
|
+
#### Development / Latest Version
|
|
44
|
+
|
|
45
|
+
Install directly from the GitHub repository. You can specify a branch, tag, or commit hash using the `#` prefix:
|
|
41
46
|
|
|
42
47
|
```bash
|
|
43
|
-
|
|
48
|
+
# Latest from main branch
|
|
49
|
+
npm install github:guoquan/flow-engine
|
|
50
|
+
|
|
51
|
+
# Specific branch
|
|
52
|
+
npm install github:guoquan/flow-engine#develop
|
|
53
|
+
|
|
54
|
+
# Specific tag
|
|
55
|
+
npm install github:guoquan/flow-engine#v0.1.9
|
|
56
|
+
|
|
57
|
+
# Specific commit hash
|
|
58
|
+
npm install github:guoquan/flow-engine#7834b6c
|
|
44
59
|
```
|
|
45
60
|
|
|
61
|
+
### 🌟 Highlights
|
|
62
|
+
- **Modern Rendering**: Based on WebGPU for next-gen performance and visual quality.
|
|
63
|
+
- **Data-Driven**: Animation and behavior fully controlled via JSON configuration.
|
|
64
|
+
- **Zero-Dependency Core**: Pure frontend architecture, easy to integrate into any project.
|
|
65
|
+
|
|
46
66
|
### 📚 Documentation
|
|
47
67
|
Please visit **[docs/](./docs/)** for the full documentation and API references.
|
|
48
68
|
|
|
@@ -52,35 +72,53 @@ Please visit **[docs/](./docs/)** for the full documentation and API references.
|
|
|
52
72
|
|
|
53
73
|
> **"一开口，就服喽。"**
|
|
54
74
|
|
|
55
|
-
**Flow**
|
|
56
|
-
|
|
57
|
-
### 🌟 项目亮点
|
|
58
|
-
- **现代化渲染**：基于 WebGPU，提供下一代渲染性能与视觉效果。
|
|
59
|
-
- **数据驱动**：动画与行为完全通过 JSON 配置文件控制。
|
|
60
|
-
- **零依赖核心**：纯前端架构，无需后端即可运行，易于集成。
|
|
75
|
+
**Flow** 是一个高性能、轻量级的基于 WebGPU 的 Web 端数字人引擎。
|
|
61
76
|
|
|
62
|
-
###
|
|
63
|
-
- **核心**: TypeScript
|
|
64
|
-
- **渲染**: Three.js (WebGPU Renderer)
|
|
65
|
-
- **构建**: Vite
|
|
77
|
+
### 📦 安装指南
|
|
66
78
|
|
|
67
|
-
|
|
79
|
+
由于注册表平台限制，本项目在不同平台使用不同的包名作用域：
|
|
68
80
|
|
|
69
|
-
|
|
81
|
+
#### 稳定版本 (推荐)
|
|
70
82
|
|
|
83
|
+
**从 NPM 安装:**
|
|
71
84
|
```bash
|
|
72
|
-
|
|
73
|
-
|
|
85
|
+
npm install @guoquan.net/flow-engine
|
|
86
|
+
```
|
|
74
87
|
|
|
75
|
-
|
|
76
|
-
|
|
88
|
+
**从 GitHub Packages 安装:**
|
|
89
|
+
在项目根目录创建 `.npmrc` 文件:
|
|
90
|
+
```ini
|
|
91
|
+
@guoquan:registry=https://npm.pkg.github.com
|
|
77
92
|
```
|
|
93
|
+
然后安装:
|
|
94
|
+
```bash
|
|
95
|
+
npm install @guoquan/flow-engine
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
> **注意**: 命名差异（NPM 上为 `@guoquan.net`，GitHub 上为 `@guoquan`）是因为各平台对用户作用域（Scope）的要求不同。
|
|
78
99
|
|
|
79
|
-
|
|
100
|
+
#### 开发版 / 最新版本
|
|
101
|
+
|
|
102
|
+
直接从 GitHub 仓库安装。你可以使用 `#` 前缀指定分支、标签或提交哈希：
|
|
80
103
|
|
|
81
104
|
```bash
|
|
82
|
-
|
|
105
|
+
# 安装 main 分支最新代码
|
|
106
|
+
npm install github:guoquan/flow-engine
|
|
107
|
+
|
|
108
|
+
# 指定分支
|
|
109
|
+
npm install github:guoquan/flow-engine#develop
|
|
110
|
+
|
|
111
|
+
# 指定标签
|
|
112
|
+
npm install github:guoquan/flow-engine#v0.1.9
|
|
113
|
+
|
|
114
|
+
# 指定提交哈希
|
|
115
|
+
npm install github:guoquan/flow-engine#7834b6c
|
|
83
116
|
```
|
|
84
117
|
|
|
118
|
+
### 🌟 项目亮点
|
|
119
|
+
- **现代化渲染**：基于 WebGPU，提供下一代渲染性能与视觉效果。
|
|
120
|
+
- **数据驱动**：动画与行为完全通过 JSON 配置文件控制。
|
|
121
|
+
- **零依赖核心**：纯前端架构，无需后端即可运行，易于集成。
|
|
122
|
+
|
|
85
123
|
### 📚 文档索引
|
|
86
|
-
请访问 **[docs/](./docs/)** 查看完整文档与 API 说明。
|
|
124
|
+
请访问 **[docs/](./docs/)** 查看完整文档与 API 说明。
|