Metadata-Version: 2.4
Name: ai_vtuber
Version: 0.1.0
Summary:  整個套件為包含一整個可用的ai vtuber，會包括思考、說話及接收我們對話內容手段等工具
Author-email: 小ber <a0968066786b@gmail.com>
License: Copyright (c) 2025 小ber <a0968066786b@gmail.com>
        
        此軟體為專有軟體，未經授權不得使用、修改、分發或商業化。
        
        由於此軟體是我們小組的畢業專題，
        我們希望能夠保護我們的智慧財產權，
        因此我們暫先選擇使用專有軟體授權。
        
        您可以：
        - 僅在獲得授權的情況下使用此軟體。
        
        您不得：
        - 未經授權修改、分發或商業化此軟體。
        - 將此軟體用於任何非法用途。
        
        如需授權或其他問題，請聯絡作者：a0968066786b@gmail.com
        
        未來可能方向：
        - 考慮在未來釋出開源版本，屆時若開源將會更新授權條款。
        - 歡迎聯絡我們討論合作或授權事宜。
        
Project-URL: Homepage, https://github.com/Super-Boy-1/ai_vtuber.git
Project-URL: Source, https://github.com/Super-Boy-1/ai_vtuber.git
Keywords: ai,vtuber,ai vtuber,python
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Requires-Python: ~=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2.0,>=1.22.0
Requires-Dist: tqdm<5.0.0,>=4.64.0
Requires-Dist: langchain<0.3.0,>=0.1.0
Requires-Dist: langchain-ollama
Requires-Dist: langchain-core
Requires-Dist: langchain-community
Requires-Dist: ollama<1.0,>=0.0.5
Requires-Dist: tavily-python<1.0.0,>=0.3.0
Requires-Dist: requests<3.0,>=2.28
Requires-Dist: beautifulsoup4<5.0,>=4.11
Requires-Dist: pytz<2025.0,>=2022.1
Requires-Dist: pydantic<3.0,>=2.0.0
Requires-Dist: TTS<1.0,>=0.22.0
Requires-Dist: torch<3.0,>=2.0.0
Requires-Dist: transformers<4.40.0,>=4.33.0
Requires-Dist: torchcodec
Requires-Dist: langdetect<2.0,>=1.0.9
Requires-Dist: sounddevice<1.0,>=0.4.6
Requires-Dist: vosk<0.4,>=0.3.38
Requires-Dist: huggingface-hub<1.0,>=0.20.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: soundfile<1.0,>=0.10.3; extra == "dev"
Dynamic: license-file

# ai_vtuber

> 一個整合 AI 思考、語音辨識、語音合成、網路搜尋、爬蟲等多功能的 AI VTuber 工具包，支援多種工具與本地 LLM，適合自動化對話、語音互動與多模態應用。

---

**授權**：詳見 LICENSE  
**Python 版本需求**：3.10.x

## 主要特色
- 整合 LLM（Ollama）、語音辨識（Vosk）、語音合成（TTS）、網路搜尋（Tavily）、網頁爬蟲等多種工具
- 支援多語系語音合成與語音克隆
- 具備短期記憶、多輪對話、工具自定義與擴充能力
- 適合本地端部署，無需雲端依賴

## 安裝與環境建議

- **Python 版本**：需 3.10.x
- **建議使用虛擬環境**（如 venv、conda、pyenv 等）以避免套件衝突
- **Ollama 安裝**：
    - 前往 Ollama 官網下載並安裝 Ollama（ https://ollama.com/ ）
    - Linux 可用：
        ```sh
        curl -fsSL https://ollama.ai/install.sh | sh
        ```
    - Ubuntu 也可用 snap：
        ```sh
        sudo snap install ollama
        ```
    - Windows 可用：
        ```powershell
        irm https://ollama.com/install.ps1 | iex
        ```

- **FFmpeg 安裝**：
    - Linux 可用：
        ```sh
        sudo apt update
        sudo apt install ffmpeg
        ```
    - macOS 可用：
        ```sh
        brew install ffmpeg
        ```
    - Windows 可用：
        - 使用 Scoop 安裝：
        ```powershell
        scoop install ffmpeg
        ```

        - 或使用 Conda 安裝：
        ```powershell
        conda install -c conda-forge ffmpeg
        ```

- **PortAudio 安裝**：
    - Linux 可用：
        ```sh
        sudo apt update
        sudo apt install portaudio19-dev
        ```
    - macOS 可用：
        ```sh
        brew install portaudio
        ```
    - Windows 可用：
        ```powershell
        scoop install portaudio
        ```

- **安裝依賴套件**：
    - 於專案根目錄執行：
        ```sh
        pip install ai_vtuber
        ```

- **下載 LLM 模型**：
    - 於命令列執行：
        ```sh
        ollama pull <model>
        ```
    - 可至 Ollama 官網查詢更多模型

---

## 使用方式

- 啟動虛擬環境（如有）
- 執行主程式（請依你的主程式檔名調整）：
    ```sh
    python your_main.py
    ```

## 主要功能簡介

- 支援文字與語音互動，具備短期記憶
- 可使用agent
- 工具可擴充，支援自訂函式註冊
- 內建多種常用工具（時間查詢、打招呼、搜尋、爬蟲、語音辨識、語音合成等）

---

## 其他

- 詳細 API 與工具用法請參考 API_DOC.md
- 有任何問題歡迎聯絡作者
