@shifu-hu/dsh-boot-sequence 0.0.0-stage → 1.0.1

package/CREDITS.md

@@ -0,0 +1,47 @@
+# 素材署名与许可
+
+本插件包含两处**非自行创作**的第三方素材。它们各自的许可义务如下，分发或改编时请保留本文件。
+
+## 1. 鲸鱼娘形象（`assets/mascot/whalegirl.webp`）
+
+基于成熟版（女仆装）设定图 `dafeiyu-mature-character-sheet.png`，
+取该图**左上约 75% 区域**（正面立绘的头部与上身，非全身），
+再经边缘检测提取线稿、去除相邻人物的串入部分、并以单色重绘为**无颜色线稿**。
+
+> 该设定图沿用 [xiaoweigen/deepseek-dafeiyu-assets](https://github.com/xiaoweigen/deepseek-dafeiyu-assets)
+> 所整理的 DeepSeek 大肥鱼／鲸鱼娘形象体系：
+> 原始角色形象「上善无形（上善）」；DeepSeek 女仆形象二次设计「ZipZipPipe」；
+> Q 版设定图参考「YunYueSama」（https://github.com/YunYueSama/codex-deepseek-pet）；
+> 本组改编与整理「xiaoweigen」。
+>
+> 上游改编贡献许可：**CC BY-NC-SA 4.0**
+> （https://creativecommons.org/licenses/by-nc-sa/4.0/），保留适用的完整上游许可。
+>
+> 本插件新增修改：裁切为正面头身、提取边缘线稿、剔除相邻视图残影、
+> 去除全部色彩并以单色重绘、缩放至 520px 高。
+
+**非商业使用**：不得以获取商业优势或金钱报酬为主要目的使用该素材。
+如用于商业场景，请替换为自有素材。
+
+## 2. 启动音效（`audio/*.wav`）
+
+直接取自 [GitSquared/edex-ui](https://github.com/GitSquared/edex-ui) 的
+`src/assets/audio/`，未作修改：
+
+| 文件 | 用途 | 原路径 |
+|---|---|---|
+| `stdout.wav` | 每打印一行 boot log 时播放 | `src/assets/audio/stdout.wav` |
+| `granted.wav` | 打印到 `Boot Complete` 时播放 | `src/assets/audio/granted.wav` |
+| `theme.wav` | 标题屏出现时播放 | `src/assets/audio/theme.wav` |
+
+eDEX-UI 以 **GPL-3.0** 发布；其自带音效文件随仓库分发。本项目对 eDEX-UI 的
+使用限于此三份音频素材，未复制其代码（时序逻辑为依据 `boot_screen.css` /
+`_renderer.js` 的公开行为重新实现）。
+
+## 3. 字体
+
+| 文件 | 来源 | 许可 |
+|---|---|---|
+| `build/fonts/*.woff2` | United Sans Medium、Fira Mono 子集 | 各自 OFL / 随 eDEX-UI 分发 |
+
+字体经 `pyftsubset` 子集化后以 base64 内联进样式表，未修改字形设计。

package/LICENSE

@@ -0,0 +1,38 @@
+MIT License
+
+Copyright (c) 2026 Shifu-HU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+THIRD-PARTY NOTICE
+
+This MIT license covers the plugin source written for this project. Two
+bundled assets carry their own licenses and are NOT relicensed here:
+
+1. Whale-girl mascot (assets/mascot/whalegirl.webp)
+   CC BY-NC-SA 4.0 — non-commercial, attribution required.
+   Upstream authors: 上善无形（上善）, ZipZipPipe, YunYueSama, xiaoweigen
+   https://github.com/xiaoweigen/deepseek-dafeiyu-assets
+
+2. Boot audio cues (assets/audio/*.wav)
+   From GitSquared/edex-ui, GPL-3.0.
+
+See CREDITS.md for the full attribution record.

package/README.md

@@ -1,3 +1,112 @@
-# Temporary Holding Version
+# dsh-boot-sequence
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An [eDEX-UI](https://github.com/GitSquared/edex-ui) style boot sequence for the
+**the agent runtime** Web UI: a full-screen splash that prints an 85-line boot
+log, lands a glitching title plate, and fades into the workspace.
+
+[中文说明](README.zh-CN.md)
+
+[![npm](https://img.shields.io/npm/v/@shifu-hu/dsh-boot-sequence.svg)](https://www.npmjs.com/package/@shifu-hu/dsh-boot-sequence)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+![preview](https://raw.githubusercontent.com/Shifu-HU/dsh-boot-sequence/main/docs/preview.png)
+
+## Install
+
+Published on npm: **[@shifu-hu/dsh-boot-sequence](https://www.npmjs.com/package/@shifu-hu/dsh-boot-sequence)**
+
+```bash
+# from the npm registry (recommended)
+plugin_manager install_bundle @shifu-hu/dsh-boot-sequence
+
+# pin a version
+plugin_manager install_bundle @shifu-hu/dsh-boot-sequence@1.0.0
+```
+
+### From Git
+
+```bash
+plugin_manager install_bundle git+https://github.com/Shifu-HU/dsh-boot-sequence.git
+```
+
+### From a local folder
+
+```bash
+plugin_manager install_bundle C:/path/to/dsh-boot-sequence
+```
+
+Restart the desktop app after installing. The Client module is scanned at
+startup, so a hot install does not take effect until the next launch.
+
+## First use
+
+Nothing to configure. Open the app and the sequence plays once, then removes
+itself.
+
+| Action | Result |
+|---|---|
+| `Esc` | Fade out immediately |
+| Click anywhere | Fade out immediately |
+| Wait ~8.5s | Plays through and fades into the workspace |
+
+## How it behaves
+
+- **One shot per page load.** It does not replay on session or route changes.
+- **Self-removing.** The component returns `null` when finished; its timers,
+  listeners and stylesheet are released.
+- **Pointer-transparent.** It never swallows clicks after the fade starts.
+- **Sound is optional.** Browsers block audio without a gesture, so the cues
+  begin after your first click. Silence never blocks the animation.
+
+## Uninstall
+
+```bash
+plugin_manager remove_bundle @shifu-hu/dsh-boot-sequence
+```
+
+Or toggle it off in **Settings → Plugins**.
+
+## Troubleshooting
+
+| Symptom | Cause | Fix |
+|---|---|---|
+| Nothing appears after install | Client modules are scanned at startup | Restart the desktop app |
+| Blank screen instead of the log | Module failed to load | Check DevTools console for `slot entry crashed` |
+| No sound | Browser autoplay policy | Click the page once during the animation |
+| Mascot missing | Asset route blocked | Confirm `/plugins/@shifu-hu/dsh-boot-sequence/assets/mascot/whalegirl.webp` returns 200 |
+| Animation replays every navigation | Should not happen | Report it; the unmount guard is in `client.js` |
+
+## Build from source
+
+The shipped `client.js` is generated. Edit `src/client.template.js`, then:
+
+```bash
+python3 tools/build-fonts-css.py     # inline subset fonts
+node tools/build-client.cjs          # fold data + fonts + audio into client.js
+node tools/contract-test.cjs         # load-and-render contract
+node tools/precheck.cjs              # manifest, assets, attribution
+```
+
+`tools/render-stills.cjs` renders the real component in headless Chromium for
+visual checks.
+
+## Limitations
+
+- Text is English-only in the boot log; it mirrors eDEX-UI's console output.
+- The mascot is line art traced from a third-party character sheet; it is
+  **not** original artwork (see Credits).
+- No configuration options yet.
+
+## Credits
+
+Third-party assets and their licenses are recorded in [CREDITS.md](CREDITS.md).
+
+- Whale-girl mascot — CC BY-NC-SA 4.0, upstream authors 上善无形（上善）· ZipZipPipe · YunYueSama · xiaoweigen
+- Boot audio — GitSquared/edex-ui, GPL-3.0
+
+**The mascot is non-commercial.** Remove it before any commercial distribution.
+
+## License
+
+MIT for the plugin source — see [LICENSE](LICENSE). The bundled assets keep
+their own licenses and are not relicensed by it.

package/README.zh-CN.md

@@ -0,0 +1,105 @@
+# dsh-boot-sequence
+
+[English](README.md) | 中文
+
+给 **the agent runtime** Web UI 的开机动画，致敬
+[eDEX-UI](https://github.com/GitSquared/edex-ui)：全屏启动画面，逐行打印 85 行
+boot log，落到一个会抖动的标题牌，然后淡出进入工作区。
+
+![预览](https://raw.githubusercontent.com/Shifu-HU/dsh-boot-sequence/main/docs/preview.png)
+
+[![npm](https://img.shields.io/npm/v/@shifu-hu/dsh-boot-sequence.svg)](https://www.npmjs.com/package/@shifu-hu/dsh-boot-sequence)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+## 安装
+
+已发布到 npm：**[@shifu-hu/dsh-boot-sequence](https://www.npmjs.com/package/@shifu-hu/dsh-boot-sequence)**
+
+```bash
+# 从 npm 安装（推荐）
+plugin_manager install_bundle @shifu-hu/dsh-boot-sequence
+
+# 指定版本
+plugin_manager install_bundle @shifu-hu/dsh-boot-sequence@1.0.0
+```
+
+### 从 Git
+
+```bash
+plugin_manager install_bundle git+https://github.com/Shifu-HU/dsh-boot-sequence.git
+```
+
+### 从本地目录
+
+```bash
+plugin_manager install_bundle C:/path/to/dsh-boot-sequence
+```
+
+安装后需**重启桌面端**。Client 模块在启动时扫描，热安装不会立即生效。
+
+## 首次使用
+
+无需任何配置。打开应用即播放一次，播完自行卸载。
+
+| 操作 | 结果 |
+|---|---|
+| 按 `Esc` | 立即淡出 |
+| 点击任意位置 | 立即淡出 |
+| 等待约 8.5 秒 | 完整播放并淡入工作区 |
+
+## 行为说明
+
+- **每次页面加载播放一次**，不会随会话或路由切换重播。
+- **自动卸载**：结束后组件返回 `null`，定时器、监听器、样式表一并释放。
+- **不拦截点击**，淡出开始后不再遮挡操作。
+- **声音可选**：浏览器策略会拦截无手势的音频，首次点击后才开始出声；静音不影响动画。
+
+## 卸载
+
+```bash
+plugin_manager remove_bundle @shifu-hu/dsh-boot-sequence
+```
+
+或在 **设置 → 插件** 中关闭。
+
+## 常见问题
+
+| 现象 | 原因 | 处理 |
+|---|---|---|
+| 装完没反应 | Client 模块启动时才扫描 | 重启桌面端 |
+| 白屏，没有 boot log | 模块加载失败 | 看 DevTools Console 是否有 `slot entry crashed` |
+| 没有声音 | 浏览器自动播放策略 | 播放期间点一下页面 |
+| 鲸鱼娘不显示 | 资源路由被拦 | 确认 `/plugins/@shifu-hu/dsh-boot-sequence/assets/mascot/whalegirl.webp` 返回 200 |
+| 每次切换页面都重播 | 不应发生 | 请反馈，卸载守卫在 `client.js` 中 |
+
+## 从源码构建
+
+发布的 `client.js` 是生成物。改 `src/client.template.js`，然后：
+
+```bash
+python3 tools/build-fonts-css.py     # 内联字体子集
+node tools/build-client.cjs          # 把数据、字体、音效折进 client.js
+node tools/contract-test.cjs         # 加载并渲染契约测试
+node tools/precheck.cjs              # 清单、资源、署名检查
+```
+
+`tools/render-stills.cjs` 可在无头 Chromium 里渲染真实组件做视觉核对。
+
+## 已知限制
+
+- boot log 为英文，与 eDEX-UI 的控制台输出保持一致。
+- 鲸鱼娘是从第三方设定图提取的线稿，**并非原创美术**（见署名）。
+- 暂无配置项。
+
+## 署名
+
+第三方素材与许可见 [CREDITS.md](CREDITS.md)。
+
+- 鲸鱼娘形象 —— CC BY-NC-SA 4.0，上游作者：上善无形（上善）· ZipZipPipe · YunYueSama · xiaoweigen
+- 启动音效 —— GitSquared/edex-ui，GPL-3.0
+
+**鲸鱼娘素材为非商业使用**，任何商业发行前必须替换。
+
+## 许可
+
+插件源码采用 MIT —— 见 [LICENSE](LICENSE)。随附素材保留各自许可，不因本项目而重新授权。