neuro-simulator 0.5.2__tar.gz → 0.5.4__tar.gz

neuro_simulator-0.5.4/.github/workflows/release.yml

@@ -0,0 +1,164 @@
+name: Release
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'server-v*.*.*'
+      - 'client-v*.*.*'
+
+jobs:
+  release-server:
+    name: Release Server to PyPI and GitHub
+    if: startsWith(github.ref, 'refs/tags/server-v')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Get version from tag
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF_NAME#server-v}" >> $GITHUB_OUTPUT
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: '20'
+
+      - name: Install build dependencies
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Generate Release Notes
+        id: generate_notes
+        run: |
+          PREVIOUS_TAG=$(git tag --list 'server-v*.*.*' --sort=-v:refname | sed -n '2p')
+          if [ -z "$PREVIOUS_TAG" ]; then
+            COMMIT_RANGE=$(git rev-list --max-parents=0 HEAD)
+          else
+            COMMIT_RANGE="$PREVIOUS_TAG..${{ github.ref_name }}"
+          fi
+          
+          RELEASE_NOTES=$(git log $COMMIT_RANGE --pretty=format:"* %s" | grep -E '\(.*\bserver\b.*\):' | sed -E 's/^\* ([^:]+):/\* \*\*\1:\*\*/')
+          
+          if [ -z "$RELEASE_NOTES" ]; then
+            RELEASE_NOTES="No specific changes for this release."
+          fi
+          
+          echo "release_notes<<EOF" >> $GITHUB_OUTPUT
+          echo -e "## Changes\n\n$RELEASE_NOTES" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+
+      - name: Create GitHub Release and Upload Assets
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref }}
+          name: "Server v${{ steps.get_version.outputs.VERSION }}"
+          body: ${{ steps.generate_notes.outputs.release_notes }}
+          files: dist/*
+
+  release-client:
+    name: Release Client
+    if: startsWith(github.ref, 'refs/tags/client-v')
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Get version from tag
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF_NAME#client-v}" >> $GITHUB_OUTPUT
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: '20'
+
+      - name: Install frontend dependencies
+        run: npm install
+        working-directory: ./client
+
+      - name: Install Tauri dependencies (Ubuntu)
+        if: matrix.platform == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
+
+      - name: Build Tauri App
+        uses: tauri-apps/tauri-action@v0
+        id: tauri
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          projectPath: ./client
+
+      - name: Generate Release Notes (Linux job only)
+        if: matrix.platform == 'ubuntu-latest'
+        id: generate_notes
+        shell: bash
+        run: |
+          PREVIOUS_TAG=$(git tag --list 'client-v*.*.*' --sort=-v:refname | sed -n '2p')
+          if [ -z "$PREVIOUS_TAG" ]; then
+            COMMIT_RANGE=$(git rev-list --max-parents=0 HEAD)
+          else
+            COMMIT_RANGE="$PREVIOUS_TAG..${{ github.ref_name }}"
+          fi
+          RELEASE_NOTES=$(git log $COMMIT_RANGE --pretty=format:"* %s" | grep -E '\(.*\bclient\b.*\):' | sed -E 's/^\* ([^:]+):/\* \*\*\1:\*\*/')
+          if [ -z "$RELEASE_NOTES" ]; then
+            RELEASE_NOTES="No specific changes for this release."
+          fi
+          echo "release_notes<<EOF" >> $GITHUB_OUTPUT
+          echo -e "## Changes\n\n$RELEASE_NOTES" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Archive static web app (Linux job only)
+        if: matrix.platform == 'ubuntu-latest'
+        run: zip -r web.zip ./client/dist
+        shell: bash
+
+      - name: Create Release and Upload Linux/Web Assets
+        if: matrix.platform == 'ubuntu-latest'
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: "Client v${{ steps.get_version.outputs.VERSION }}"
+          body: ${{ steps.generate_notes.outputs.release_notes }}
+          files: |
+            ./web.zip
+            client/src-tauri/target/release/bundle/appimage/*.AppImage
+            client/src-tauri/target/release/bundle/deb/*.deb
+
+      - name: Upload Windows Assets
+        if: matrix.platform == 'windows-latest'
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: |
+            client/src-tauri/target/release/bundle/msi/*.msi
+            client/src-tauri/target/release/bundle/nsis/*.exe

neuro_simulator-0.5.4/.gitignore

@@ -0,0 +1,127 @@
+# .gitignore
+
+# ---------------------------------------------------------------------------
+# --- General / OS ----------------------------------------------------------
+# ---------------------------------------------------------------------------
+# Logs and databases
+logs
+*.log
+*.sql
+*.sqlite
+
+# OS-generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# ---------------------------------------------------------------------------
+# --- IDEs / Editors --------------------------------------------------------
+# ---------------------------------------------------------------------------
+.idea/
+.vscode/
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# ---------------------------------------------------------------------------
+# --- Python Specific -------------------------------------------------------
+# ---------------------------------------------------------------------------
+# Virtual Environments
+venv/
+.venv/
+ENV/
+env/
+venv.bak/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# ---------------------------------------------------------------------------
+# --- Node.js / Client Specific -------------------------------------------
+# ---------------------------------------------------------------------------
+# Dependency directories
+node_modules/
+/jspm_packages/
+
+# Build output
+# /dist/ # 保留，因为这是Vite前端的构建输出目录
+/release/
+/out/
+/.vitepress/dist/
+/.vitepress/cache/
+
+# Cache files
+.npm/
+.eslintcache
+.stylelintcache
+.cache/
+.parcel-cache/
+*.tsbuildinfo
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Other
+*.tgz
+.yarn-integrity
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# ---------------------------------------------------------------------------
+# --- Rust / Tauri Specific -------------------------------------------------
+# ---------------------------------------------------------------------------
+# Tauri build artifacts. 
+# 注意: Cargo.lock 文件不应被忽略，以确保可复现的构建。
+target/
+gen/
+
+# ---------------------------------------------------------------------------
+# --- Project Specific & Sensitive Info -------------------------------------
+# ---------------------------------------------------------------------------
+# Secrets and environment variables (DO NOT COMMIT)
+.env
+.env.*
+!.env.example
+config.yaml
+
+# Personal scripts and temporary files (adjust as needed)
+/sum.sh
+/project_code_archive.md
+# 取消下面这行的注释来忽略你的开发脚本
+#/run_dev.bat

neuro_simulator-0.5.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Moha-Master]
+
+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.

neuro_simulator-0.5.4/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: neuro_simulator
+Version: 0.5.4
+Summary: Neuro Simulator Server
+Project-URL: Homepage, https://github.com/Moha-Master/neuro-simulator
+Project-URL: Repository, https://github.com/Moha-Master/neuro-simulator
+Project-URL: Issues, https://github.com/Moha-Master/neuro-simulator/issues
+Author-email: Moha-Master <hongkongreporter@outlook.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: azure-cognitiveservices-speech
+Requires-Dist: fastapi
+Requires-Dist: google-genai
+Requires-Dist: jinja2
+Requires-Dist: letta-client
+Requires-Dist: mutagen
+Requires-Dist: openai
+Requires-Dist: pydantic
+Requires-Dist: python-multipart
+Requires-Dist: pyyaml
+Requires-Dist: uvicorn
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Neuro Simulator
+
+***关注Vedal喵，关注Vedal谢谢喵***
+
+*本临时README和所有代码均由AI生成*
+
+Neuro Simulator 是一个模拟 Neuro-sama 直播的项目  
+它通过调用 Letta（一个为 LLM 添加自主记忆功能的项目），也可使用自带的有记忆 Agent，配合其他 LLM 服务生成的模拟观众，模拟一场 Neuro-sama 的 Just Chatting 直播  
+它能生成实时的虚拟聊天内容，并通过 TTS 合成语音，提供沉浸式的 Twitch vedal987 频道观看体验  
+
+## 特性
+
+和其他大佬的类似项目不同，本项目的重点在于尽可能模拟 Neuro-sama 在 Twitch 上的 Tuesday Stream，因此不会有太多的自定义部分  
+后续有低成本低性能方法实现 Evil 音色模仿的时候，可能加入 Evil 的 Just Chatting 乃至各种主题的 Twin Stream
+
+### 预览
+
+*这图是较旧版本的，现在小牛已经和现实中一样换新家了*
+
+演示视频：[哔哩哔哩](https://www.bilibili.com/video/BV1Aot4zTEwt)
+
+<img src="docs/assets/start.gif" width="500" />
+
+### 核心亮点
+
+- **多客户端支持**：支持多个客户端连接，实时广播内容
+- **配置热重载**：通过 Web 控制面板修改和热重载配置
+- **双 Agent 模式**：支持 Letta Agent 和内建 Agent，提供更多自定义选项
+- **Agent 记忆管理**：内建 Agent 支持多种记忆类型（初始化记忆、核心记忆、临时记忆、上下文）
+
+## 快速开始
+
+1.  **准备外部服务**：确保你拥有必要的 API 密钥，包括 LLM（Gemini/OpenAI）和 Azure TTS；如果使用 Letta，也请注册好相关的 API
+2.  **安装服务端**：
+    ```bash
+    pip install neuro-simulator
+    ```
+3.  **运行服务端**：
+    ```bash
+    neuro
+    ```
+    记得填写好配置目录中的 `config.yaml`
+      - 不指定 `--dir` 则自动创建和默认使用 `~/.config/neuro-simulator/` 作为工作目录
+      - 在默认或指定目录及需要的文件不存在时，程序会自动用自带模板复制一份到工作目录下
+
+4.  **安装客户端**：
+    ```bash
+    cd client
+    npm install
+    ```
+5.  **运行客户端**：
+    ```bash
+    npm run dev
+    ```
+6.  **部署控制面板**：
+    ```bash
+    cd dashboard_web
+    python -m http.server 8080
+    ```
+
+更多更复杂或者更简单的使用方式，请参见三个部分的详细文档
+
+## 项目结构
+
+```
+Neuro-Simulator/
+├── server/           # 服务端
+├── client/           # 客户端
+├── dashboard_web/    # Web控制面板
+├── docs/             # 文档和示例文件
+│   ├── letta_agents_example/  # Letta Agent 模板示例
+│   ├── assets/       # README中使用的媒体文件
+│   └── working_dir_example/   # 工作目录示例
+└── README.md         # 项目说明文档
+```
+
+## 详细文档
+
+有关安装、配置和使用的详细信息，请参阅详细的 README 文件：
+
+- [服务端 README](server/README.md)
+- [客户端 README](client/README.md)
+- [控制面板 README](dashboard_web/README.md)
+
+## 开发计划和已实现功能
+
+- 服务端
+  - [x] Neuro Agent 模块
+    - [x] 基于 Letta 的 Neuro Agent
+    - [x] 内建的 Neuro Agent
+      - [x] 基本的对话和上下文功能
+      - [x] 自动和手动记忆管理，包括系统提示、核心记忆、临时记忆
+      - [x] prompt 完整内容编辑
+      - [ ] 工具调用
+        - [x] 内建工具及调用
+          - [x] 记忆管理
+          - [ ] 直播标题修改
+          - [x] 对外发言
+          - [ ] 发起投票和查看结果
+          - [x] 旋转和缩放模型
+          - [ ] 调整 TTS 语速
+          - [ ] 禁言指定名称用户
+          - [ ] 播放音效
+        - [ ] 模块化热插拔工具
+        - [ ] 连接到 MCP 服务器
+        - [ ] 兼容 Offical [Neuro SDK](https://github.com/VedalAI/neuro-sdk)
+    - [ ] 拉起和对话 Evil Agent
+  - [ ] Evil Agent 模块，~~卖掉了~~ 待 Neuro Agent 完善、有低成本低性能方法实现 Evil 音色模仿的时候加入
+  - [ ] 对 Neuroverse 更多成员的 AI Agent 复现，进而允许 Neuro Agent 向其发送 DM（语音聊天可能不太现实）
+  - [x] Chatbot 模块
+    - [x] 无状态 Chatbot（即将弃用）
+      - [x] Username 的自动生成和预置替换补充
+      - [x] prompt 编辑
+      - [x] 调用 Gemini 和 OpenAI API 格式的LLM
+      - [x] 基于 Neuro Agent 的上一句内容而做出 Reaction
+      - [ ] ~~在 prompt 中包含直播标题等更多信息~~ 将在更详细的 Chatbot Agent 中实现
+      - [x] ~~实现更长的上下文~~ 将在更详细的 Chatbot Agent 中实现
+    - [x] Chatbot Agent
+      - [x] 更好的用户名生成逻辑
+      - [x] 更长的上下文，包括自身输出和 Neuro Agent 内容
+      - [ ] 在 prompt 中包含直播标题、Neuro 和 Twitch 相关背景知识等更多信息
+      - [x] 类似 Neuro Agent 的记忆系统，实现有状态 Chatbot Agent
+  - [ ] 真实的 Filter 模块，取代 Agent prompt 中的自我 Filtered.
+  - [x] 对外 API 接口，包括常规的 http 和 ws 端点
+  - [x] Twitch Chat 及管理
+    - [x] 普通 Chat
+      - [x] 随机池机制，从中抽取消息注入 Neuro
+    - [x] 醒目留言 Highlight Messages
+      - [x] 队列机制，先进先出
+      - [ ] 可选的 TTS Guy
+    - [ ] Subs 和 Donations 相关机制
+    - [ ] 禁言指定名称用户
+  - [x] 配置管理和热重载
+  - [x] TTS 合成和推送
+    - [x] Azure TTS
+    - [ ] 待定 TTS
+    - [ ] 剔除 Emoji 等特殊字符
+  - [x] 进行直播和直播环节
+    - [x] Just Chatting 单人直播
+      - [x] Neuro Stream
+      - [ ] Evil Stream
+    - [ ] Karaoke 歌回直播
+    - [ ] Twin 闲聊或主题直播
+    - [ ] 艺术鉴赏直播环节
+  - [x] 多客户端连接和广播
+    - [ ] 动态推送开场 Starting Soon 视频
+    - [x] 直播阶段
+      - [x] Starting Soon
+      - [x] 神の上升
+      - [x] 常规直播
+      - [ ] Ending
+    - [x] 直播和聊天室内容
+    - [x] 醒目留言 Highlight Messages
+    - [x] 直播标题和标签等信息
+  - [ ] 在非直播的空闲时间自动获取真实世界中 Neuro 的近期直播内容，更新完善记忆内容（不是微调训练）
+  - [ ] 对 Ollama 等本地 LLM 的优化
+  - [ ] 服务端内嵌管理面板
+    - [ ] Web 控制面板
+    - [ ] 使用 PyInquiry 的命令行面板
+- 客户端
+  - [ ] 仅包含直播区域的客户端，适用于希望使用 OBS 或其他软件推流画面的用户
+  - [x] 可自定义的用户信息和服务端地址
+  - [x] 仿 Twitch 直播界面
+    - [x] 响应式设计
+    - [x] 主要界面元素
+    - [ ] 次级页面
+    - [x] Twitch Chat 和其他互动
+      - [x] 普通聊天的发送和查看
+      - [x] 使用 Bits 和 Channel Points 发送醒目留言 Highlight Messages
+      - [ ] 表情发送
+      - [ ] Bits & Channel Points 逻辑
+      - [ ] 小牛最爱的 Subs 和 Donations 相关逻辑
+      - [ ] 参与投票
+    - [x] 主播和直播信息
+      - [x] 头像、名称信息
+      - [x] 动态更新的直播标题、分区、标签
+      - [x] 动态更新的人数和直播时长
+      - [ ] 下滑的更多主播信息
+    - [x] 使用 html 模拟的直播场景
+      - [x] 仿真字幕样式
+        - [x] 字体和描边效果
+        - [x] 逐字跳出效果
+        - [x] 随内容量的字号调整效果
+      - [x] 仿真 Twitch Chat Overlay
+      - [x] Neuro 立绘
+        - [x] 开场上升
+        - [ ] 表情差分
+        - [x] 旋转缩放
+        - [ ] 自然晃动
+        - [ ] 音效播放
+      - [ ] Evil 立绘
+      - [x] 醒目留言 Highlight Messages Overlay
+        - [x] 根据来源（Bits 或 Channel Points）显示不同颜色背景
+        - [x] 展示用户名和内容
+        - [x] 更真实的进入/退出动画
+  - [x] 仿 Twitch 离线界面（主播首页）
+    - [x] 响应式设计
+    - [x] 自动获取最新哔哩哔哩官号回放
+    - [ ] 自动获取上一场哔哩哔哩直播回放对应的时间、分区、回放视频链接
+    - [ ] 真实的主播首页竖屏模式界面（目前沿用针对竖屏优化过的横屏样式）
+    - [ ] 下滑的更多主播信息
+    - [ ] 其他次级页面
+  - [ ] 更多客户端（若实现原生客户端则弃用 tauri）
+    - [x] 可托管的 Web 静态页面
+    - [x] Windows 客户端
+      - [x] 基于 Tauri
+      - [ ] 原生
+    - [x] Linux 客户端
+      - [x] 基于 Tauri
+      - [ ] 原生
+    - [ ] Android 客户端
+      - [ ] 基于 Tauri
+      - [ ] 原生
+- Web 控制面板
+  - [ ] 更加便捷的启动器/启动脚本
+  - [x] 指定服务端 URL 进行连接
+  - [x] 直播的开始、停止、重启
+  - [x] 配置的查看、编辑、热重载
+  - [x] 服务端实时日志查看
+    - [ ] 按照等级进行日志筛选
+  - [x] Agent管理
+    - [x] 对话上下文查看
+      - [x] 对话方式展现
+      - [x] 上下文方式展现
+      - [x] 实时更新
+      - [x] 更好的界面
+      - [ ] 可视化展现 Agent 的详细执行流程
+    - [x] 实时日志查看
+      - [ ] 按照等级进行日志筛选 
+    - [x] 记忆查看和手动管理
+    - [x] 工具
+      - [x] 简易的内建工具查看
+      - [ ] 工具管理取决于服务端开发进度
+- 杂项，有一些可能永远不会实现，有一些可能很快就能完成
+  - [ ] 一键启动器和整合包，适用于不需要分开部署的情况，或者面向普通小白用户
+  - [ ] 把三个项目模块整合为一个
+  - [ ] 基于静态立绘制作的简易Live2D，能动就行
+  - [x] 目前不会考虑语音输入
+
+    > 除非你和 Neuro 在直播中有过语音联动，那我可以叫上 Gemini 一起，给你单独定制一个（
+
+  - [ ] 等待补充…
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request 来帮助改进项目，虽然大概率会是 Gemini 2.5 或者 Qwen Coder 来处理🤣