cve-connector
Version:
UE Web 开发套件
68 lines (54 loc) • 3.16 kB
Markdown
# 如何引入调试面板？
- 定义 `<cve-player>` 组件之前先初始化调试面版
```ts
import { defineContainer } from '~/utils/web-component'
import { useUI } from '~/utils/signaling'
import { createDebugUI } from '~/utils/debug-ui'
useUI(createDebugUI)
defineContainer((player) => {
if (!player) {
return
}
player.onstart = () => {
console.log('Pixel Streaming Started!')
}
})
```
# 如何修改常用调试参数但不影响主程序？
- 复制 .env 文件并重命名，部分命名规则见表格
| 文件名 | 文件是否上传 git | 开发环境 | 生产环境 | 预发布环境 |
| ---------------------- | :--------------: | :------: | :------: | :--------: |
| .env | ✔ | ✔ | ✔ | ✔ |
| .env.local | - | ✔ | ✔ | ✔ |
| .env.development | ✔ | ✔ | - | - |
| .env.development.local | - | ✔ | - | - |
| .env.production | ✔ | - | ✔ | - |
| .env.production.local | - | - | ✔ | - |
| .env.staging | ✔ | - | - | ✔ |
| .env.staging.local | - | - | - | ✔ |
- 修改对应的环境变量
| 环境变量 | 用途 |
| -------------------- | -------------------------------------------- |
| CVE_ACTOR_TAG | Actor 测试用例 |
| CVE_APPLICATION_NAME | 云渲染实例名称 |
| CVE_ASPECT_RATIO | 像素流横纵比 |
| CVE_DATASMITH_PATH | Datasmith 测试用例 |
| CVE_DEBUG_PANEL | 调试面板默认展开 |
| CVE_LOCATION_X | 视角飞行默认坐标: X |
| CVE_LOCATION_Y | 视角飞行默认坐标: Y |
| CVE_LOCATION_Z | 视角飞行默认坐标: Z |
| CVE_MAIN_LEVEL | 主关卡测试用例 |
| CVE_MATCHMAKER_URL | 云渲染服务访问地址 |
| CVE_MODE | 数据通讯模式: PixelStreaming/WebSocket/WebUI |
| CVE_ROTATION_P | 视角飞行默认角度: Pitch |
| CVE_ROTATION_R | 视角飞行默认角度: Roll |
| CVE_ROTATION_Y | 视角飞行默认角度: Yaw |
| CVE_SEQUENCE_NAME | Sequence 测试用例 |
| CVE_SIGNALING_URL | 像素流实例/信令服务地址 |
| CVE_STREAMING_LEVELS | 流关卡测试用例，多个流关卡使用英文逗号拼接 |
| CVE_VIEW_BOOKMARK | 视角书签测试用例 |
# 如何打包调试程序？
- package.json 中已设置打包指令。
```cmd
npm run build:cve
```