Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

嗷呜点歌机默认 Mod UI

这是嗷呜点歌机为 OBS、直播姬等直播软件提供的官方 Mod UI 组件。通过直播软件的“浏览器捕捉”将它叠加到直播画面中,就能快速搭建清晰、美观的直播间点歌展示。

本仓库同时也是一套完整、可运行的 Mod UI 开发示例。你可以参考它的项目结构、数据读取方式和状态展示逻辑,修改配色与布局,或制作更适合自己直播间风格的 UI。

组件采用透明背景,集中展示当前播放歌曲、待播队列和必要的状态提醒;暂停队列播放或暂停接收点歌时,对应区域会用醒目的颜色提示主播和观众。

嗷呜点歌机默认 Mod UI 的直播展示效果

安装

在嗷呜点歌机 1.1.4 或更高版本的“运行状态 → Mod UI”中输入:

https://github.com/Enkianssus/AwooMusicBot-Overlay-Default

也可以从 Releases 下载 awoo-overlay.zip,点击“选择 ZIP”或把 ZIP 拖入安装区域。OBS 始终使用点歌机显示的固定 /overlay/ 地址,切换 UI 不需要重建浏览器来源。

本地预览

直接打开源码时,页面默认读取 127.0.0.1:5556。点歌机安装后的页面会自动使用自身端口。

可用参数:

  • maxQueue=3:显示的队列条数,范围 1–30。
  • port=5556:仅用于直接打开本地源码时覆盖 API 端口。

开发约束

  • ZIP 根目录必须有 overlay.json 和其中声明的入口 HTML。
  • 使用外部 JavaScript 文件,不使用内联脚本。
  • 只读取 GET /api/v1/stateGET /api/v1/currentGET /api/v1/queue/ws
  • 外部文字使用 textContent 写入 DOM,避免拼接到 innerHTML
  • 保持页面背景透明,方便作为 OBS 浏览器组件叠加。

协议与安全限制见嗷呜点歌机仓库的 Mod UI 文档

License

MIT

Releases

Packages

Contributors

Languages