ncatbot5 5.0.0rc7__tar.gz

ncatbot5-5.0.0rc7/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,69 @@
+name: 🐛 Bug 汇报
+description: 创建一个 Bug 汇报以帮助我们改进
+title: "[BUG] "
+labels: ["bug"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢花时间汇报！
+
+  - type: textarea
+    id: describe
+    attributes:
+      label: 1. 问题现象（必填）
+      description: 发生了什么？期望发生什么？
+      placeholder: |
+        清晰简洁地描述现象与期望结果。
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: 2. 复现步骤（必填，最好包括代码）
+      description: 如何稳定复现？越具体越好
+      placeholder: |
+        1. 启动 NapCat …
+        2. 发送消息 …
+        3. 看到报错 …
+    validations:
+      required: true
+
+  - type: textarea
+    id: env
+    attributes:
+      label: 3. 运行环境（必填）
+      description: 建议直接复制下面三行填写
+      placeholder: |
+        - OS: Win11 23H2 / Ubuntu 22.04
+        - NcatBot: v4.2.x
+        - NapCat: v4.x.y
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: 4. 关键日志 / 截图
+      description: 日志请复制**文本**（不要截长图），敏感信息请打码
+      render: text
+
+  - type: textarea
+    id: config
+    attributes:
+      label: 5. 相关配置项
+      description: 只贴**改动过**的片段，用 ```yaml 包裹
+      render: yaml
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: 6. 自查清单
+      options:
+        - label: 我已经升级到最新版（NcatBot & NapCat）
+          required: true
+        - label: 我已经搜索过历史 Issues
+          required: true

ncatbot5-5.0.0rc7/.github/workflows/pypi-publish.yml

@@ -0,0 +1,63 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - main  # 指定触发的分支，根据实际情况修改
+    paths:
+      - "pyproject.toml"  # 当 pyproject.toml 文件发生变化时触发
+  workflow_dispatch:  # 允许手动触发
+
+permissions:
+  contents: read
+
+jobs:
+  # test:
+  #   runs-on: ubuntu-latest
+  #   strategy:
+  #     matrix:
+  #       python-version: ["3.13", "3.11", "3.9"]
+
+  #   steps:
+  #     - uses: actions/checkout@v4
+
+  #     - name: Install uv
+  #       uses: astral-sh/setup-uv@v4
+
+  #     - name: Set up Python ${{ matrix.python-version }}
+  #       run: uv python install ${{ matrix.python-version }}
+
+  #     - name: Install dependencies
+  #       run: uv sync --extra dev
+
+  #     - name: Run tests
+  #       run: uv run pytest
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      # 重要：如果使用 OIDC 发布，需要这个权限
+      id-token: write
+    # needs:
+      # - test  # 如果启用了测试 Job，则在测试通过后再发布
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        # 使用官方专用的 Action
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # 如果你在 PyPI 开启了 Trusted Publishing，甚至不需要配置 TOKEN
+          password: ${{ secrets.PYPI_TOKEN }}

ncatbot5-5.0.0rc7/.github/workflows/pytest.yml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13", "3.11", "3.9"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest --no-cov

ncatbot5-5.0.0rc7/.gitignore

@@ -0,0 +1,182 @@
+# 在项目根目录创建 .gitignore
+echo "dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc" >> .gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+uv.lock
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+<<<<<<< HEAD
+# Virtual environments and environment files
+.venv/
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+.env
+.venv
+uv.lock
+=======
+# PyBuilder
+.pybuilder/
+target/
+>>>>>>> origin/main
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyPI configuration file
+.pypirc
+.fseventsd
+
+# 开发工具
+.vscode/
+.cursor/
+.idea/
+
+# Runtime
+logs/
+/data
+/plugins
+/napcat
+
+# development
+dev/
+
+# Misc
+.ipynb_checkpoints
+*.log
+*.sqlite3
+*.sqlite3-journal
+*.DS_Store

ncatbot5-5.0.0rc7/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_stages: [pre-commit, pre-push, manual]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-ast
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: detect-private-key
+      - id: debug-statements
+      - id: mixed-line-ending
+        args: ['--fix=crlf']
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format          # 替代 black
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies: [".[toml]"]

ncatbot5-5.0.0rc7/CONTRIBUTING.md

@@ -0,0 +1,147 @@
+# 贡献指南
+
+本文件仅面向开发者，说明从 fork 到提交 PR 的必要步骤。假定你已经将仓库 fork 到自己的 GitHub 账号，并从自己的 fork 克隆到本地。
+
+## 贡献步骤
+
+1. Fork 本仓库
+2. clone 你 Fork 的仓库到本地
+3. 准备开发环境
+4. 开发并测试
+5. 启用 pre-commit 钩子检查并提交
+6. 推送到你自己 Fork 的 Repo
+7. 开 Pull Request
+
+
+## 环境准备
+
+### clone 到本地
+
+```bash
+git clone https://github.com/<你的用户名>/ncatbot.git
+cd ncatbot
+```
+
+### 准备开发环境
+
+推荐使用 uv 管理环境：
+
+```bash
+uv venv
+source .venv/bin/activate  # Linux/macOS
+# 或 .venv\Scripts\activate  # Windows
+uv pip install -e '.[dev]'
+```
+
+或使用传统 pip：
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e '.[dev]'
+```
+
+### 启用 pre-commit 钩子（只需执行一次）
+
+```bash
+uv run pre-commit install
+```
+- pre-commit 会在 `git commit` 时检查代码格式并做一定自动修复。若 pre-commit 自动修复了文件，请执行 `git add` 将修复后的文件重新暂存后再提交。
+- 如果存在无法自动修复的错误，请尽量认真阅读错误描述并修复。若确有必要跳过本地检查（不推荐），可使用 `git commit --no-verify`。
+
+## 开发
+
+
+- 新建分支进行开发：
+
+```bash
+git checkout -b feat/描述性短名
+```
+
+- 使用 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 编写提交信息，例如：
+
+```bash
+git commit -m "feat: 添加消息撤回功能"
+git commit -m "fix(api): 修复消息队列溢出问题 #123"
+git commit -m "docs: 更新安装指南"
+```
+
+## 测试
+
+运行测试：
+
+```bash
+uv run pytest
+```
+
+运行带覆盖率的测试：
+
+```bash
+uv run pytest --cov=ncatbot --cov-report=term-missing
+```
+
+### 多版本测试（可选）
+
+如需在多个 Python 版本（3.13, 3.11, 3.9）上运行测试，可使用 tox：
+
+```bash
+uv run tox
+```
+
+也可以只运行特定版本：
+
+```bash
+uv run tox -e py313
+```
+
+> 注意：多版本测试不是提交 PR 的必要条件，CI 会自动在多版本上运行测试。
+
+## 依赖管理
+
+本项目使用 pip-tools 工作流管理依赖：
+
+- **pyproject.toml**：定义顶层依赖（宽泛版本）
+- **requirements.txt**：由 pip-compile 自动生成的锁定版本文件
+
+### 更新依赖
+
+如需添加或修改依赖：
+
+1. 编辑 `pyproject.toml` 中的 `dependencies` 列表
+2. 重新生成 requirements.txt：
+
+```bash
+pip-compile pyproject.toml -o requirements.txt --strip-extras
+```
+
+3. 将两个文件一起提交
+
+### 升级所有依赖到最新版本
+
+```bash
+pip-compile pyproject.toml -o requirements.txt --strip-extras --upgrade
+```
+
+## 提交 PR
+
+
+```bash
+git push origin feat/描述性短名
+```
+
+- 在 GitHub 上为上游仓库创建 Pull Request（目标仓库为原始仓库），在说明里写明变更内容并关联 Issue（如有）。
+
+## 代码规范
+
+代码规范（要点）
+- 遵循 PEP8，**尽量添加类型注解**。
+- 必要时添加清晰的 docstring，例如：
+
+```python
+def handle_event(event: Event):
+    """处理机器人事件。
+
+    Args:
+        event: 继承自 BaseEvent 的事件对象。
+    """
+```

ncatbot5-5.0.0rc7/LICENSE

@@ -0,0 +1,32 @@
+NcatBot Non-Commercial License
+
+Copyright (c) 2025 NcatBot开发项目组
+
+在遵守以下条款的前提下，特此免费授予任何获得本软件及相关文档文件（以下简称“软件”）的人员不受限制地处置本软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可的权利：
+
+一、约束条款
+1. 未经授权，禁止商业用途
+   - 不得直接或间接通过本软件获利，包括但不限于：
+     * 售卖软件副本或衍生作品
+     * 作为商业产品或服务组成部分
+     * 用于广告推广或流量变现
+     * 其他以营利为目的的使用场景
+
+2. 二次开发授权
+   - 修改后的衍生作品需满足：
+     * 必须保留原始版权声明
+     * 需通过邮件(lyh_02@foxmail.com)提交授权申请
+     * 获得书面授权后方可分发
+
+二、违约处理
+1. 违反上述条款自动终止授权
+2. 需承担因此造成的所有法律责任
+3. 侵权方需承担维权产生的合理费用
+
+三、免责声明
+本软件按"原样"提供，不做任何明示或暗示的担保，包括但不限于对适销性、特定用途适用性的担保。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责。
+
+四、管辖法律
+本协议适用中华人民共和国法律，任何争议应提交厦门仲裁委员会仲裁解决。
+
+本协议最终解释权归NcatBot开发项目组所有。

ncatbot5-5.0.0rc7/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include NOTICE
+include requirements.txt
+include pyproject.toml
+recursive-include src *.py  # 包含所有Python文件
+recursive-include src *.txt *.md  # 包含文本文件

ncatbot5-5.0.0rc7/NOTICE

@@ -0,0 +1,5 @@
+商业使用授权申请需包含：
+- 申请方基本信息
+- 使用场景描述
+- 预计用户规模
+- 联系方式

ncatbot5-5.0.0rc7/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: ncatbot5
+Version: 5.0.0rc7
+Summary: NcatBot, NapCat Python SDK
+Author-email: 木子 <lyh_02@qq.com>, huan-yp <huan_yp@qq.com>
+License: MIT
+Project-URL: Source, https://github.com/ncatbot/ncatbot
+Project-URL: Bug Reports, https://github.com/ncatbot/ncatbot/issues
+Project-URL: Documentation, https://github.com/ncatbot/ncatbot/wiki
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: schedule
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: toml
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Requires-Dist: websockets
+Requires-Dist: requests>=2.28
+Requires-Dist: aiofiles
+Requires-Dist: psutil>=5.9
+Requires-Dist: packaging
+Requires-Dist: rich
+Requires-Dist: tqdm>=4.60
+Requires-Dist: typing-extensions
+Requires-Dist: qrcode
+Requires-Dist: colorama>=0.4.6; platform_system == "Windows"
+Provides-Extra: dev
+Requires-Dist: ncatbot[test]; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: tox>=4.0; extra == "dev"
+Requires-Dist: tox-uv; extra == "dev"
+Requires-Dist: uv; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-html>=4.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+# 🚀 ncatbot
+
+---
+
+![logo.png](https://socialify.git.ci/ncatbot/NcatBot/image?custom_description=ncatbot+%EF%BC%8C%E5%9F%BA%E4%BA%8E+OneBot11%E5%8D%8F%E8%AE%AE+%E7%9A%84+QQ+%E6%9C%BA%E5%99%A8%E4%BA%BA+Python+SDK%EF%BC%8C%E5%BF%AB%E9%80%9F%E5%BC%80%E5%8F%91%EF%BC%8C%E8%BD%BB%E6%9D%BE%E9%83%A8%E7%BD%B2%E3%80%82&description=1&font=Jost&forks=1&issues=1&logo=https%3A%2F%2Fimg.remit.ee%2Fapi%2Ffile%2FAgACAgUAAyEGAASHRsPbAAO9Z_FYKczZ5dly9IKmC93J_sF7qRUAAmXEMRtA2ohX1eSKajqfARABAAMCAAN5AAM2BA.jpg&pattern=Signal&pulls=1&stargazers=1&theme=Auto)
+
+ <a href="https://pypi.org/project/ncatbot5/"><img src="https://img.shields.io/pypi/v/ncatbot5"></a>
+ [![OneBot v11](https://img.shields.io/badge/OneBot-v11-black.svg)](https://github.com/botuniverse/onebot)
+ [![访问量统计](https://visitor-badge.laobi.icu/badge?page_id=li-yihao0328.ncatbot_sync)](https://github.com/ncatbot/ncatbot)
+  <a><img src="https://img.shields.io/badge/License-NcatBot License-green.svg"></a>
+    <a href="https://qm.qq.com/q/CHbzJ2LH4k"><img src="https://img.shields.io/badge/官方群聊-201487478-brightgreen.svg"></a>
+    <a href="https://qm.qq.com/q/CHbzJ2LH4k"><img src="https://img.shields.io/badge/官方频道-pd63222487-brightgreen.svg"></a>
+    <a href="https://ippclub.org"><img src="https://img.shields.io/badge/I%2B%2B%E4%BF%B1%E4%B9%90%E9%83%A8-%E8%AE%A4%E8%AF%81-11A7E2?logo=data%3Aimage%2Fsvg%2Bxml%3Bcharset%3Dutf-8%3Bbase64%2CPHN2ZyB2aWV3Qm94PSIwIDAgMjg4IDI3NCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWw6c3BhY2U9InByZXNlcnZlIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjIiPjxwYXRoIGQ9Im0xNDYgMzEgNzIgNTVWMzFoLTcyWiIgc3R5bGU9ImZpbGw6I2Y2YTgwNjtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Im0xNjkgODYtMjMtNTUgNzIgNTVoLTQ5WiIgc3R5bGU9ImZpbGw6I2VmN2EwMDtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Ik0yNiAzMXY1NWg4MEw4MSAzMUgyNloiIHN0eWxlPSJmaWxsOiMwN2ExN2M7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJNMTA4IDkydjExMmwzMS00OC0zMS02NFoiIHN0eWxlPSJmaWxsOiNkZTAwNWQ7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJNMCAyNzR2LTUyaDk3bC0zMyA1MkgwWiIgc3R5bGU9ImZpbGw6I2Y2YTgwNjtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Im03NyAyNzQgNjctMTA3djEwN0g3N1oiIHN0eWxlPSJmaWxsOiNkZjI0MzM7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJNMTUyIDI3NGgyOWwtMjktNTN2NTNaIiBzdHlsZT0iZmlsbDojMzM0ODVkO2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0iTTE5MSAyNzRoNzl2LTUySDE2N2wyNCA1MloiIHN0eWxlPSJmaWxsOiM0ZTI3NWE7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJNMjg4IDEwMGgtMTdWODVoLTEzdjE1aC0xN3YxM2gxN3YxNmgxM3YtMTZoMTd2LTEzWiIgc3R5bGU9ImZpbGw6I2M1MTgxZjtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Im0yNiA4NiA1Ni01NUgyNnY1NVoiIHN0eWxlPSJmaWxsOiMzMzQ4NWQ7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJNOTMgMzFoNDJsLTMwIDI5LTEyLTI5WiIgc3R5bGU9ImZpbGw6IzExYTdlMjtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Ik0xNTggMTc2Vjg2bC0zNCAxNCAzNCA3NloiIHN0eWxlPSJmaWxsOiMwMDU5OGU7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJtMTA2IDU5IDQxLTEtMTItMjgtMjkgMjlaIiBzdHlsZT0iZmlsbDojMDU3Y2I3O2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0ibTEyNCAxMDAgMjItNDEgMTIgMjctMzQgMTRaIiBzdHlsZT0iZmlsbDojNGUyNzVhO2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0ibTEwNiA2MCA0MS0xLTIzIDQxLTE4LTQwWiIgc3R5bGU9ImZpbGw6IzdiMTI4NTtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Im0xMDggMjA0IDMxLTQ4aC0zMXY0OFoiIHN0eWxlPSJmaWxsOiNiYTAwNzc7ZmlsbC1ydWxlOm5vbnplcm8iLz48cGF0aCBkPSJtNjUgMjc0IDMzLTUySDBsNjUgNTJaIiBzdHlsZT0iZmlsbDojZWY3YTAwO2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0iTTc3IDI3NGg2N2wtNDAtNDUtMjcgNDVaIiBzdHlsZT0iZmlsbDojYTgxZTI0O2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0iTTE2NyAyMjJoNThsLTM0IDUyLTI0LTUyWiIgc3R5bGU9ImZpbGw6IzExYTdlMjtmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Im0yNzAgMjc0LTQ0LTUyLTM1IDUyaDc5WiIgc3R5bGU9ImZpbGw6IzA1N2NiNztmaWxsLXJ1bGU6bm9uemVybyIvPjxwYXRoIGQ9Ik0yNzUgNTVoLTU3VjBoMjV2MzFoMzJ2MjRaIiBzdHlsZT0iZmlsbDojZGUwMDVkO2ZpbGwtcnVsZTpub256ZXJvIi8%2BPHBhdGggZD0iTTE4NSAzMWg1N3Y1NWgtMjVWNTVoLTMyVjMxWiIgc3R5bGU9ImZpbGw6I2M1MTgxZjtmaWxsLXJ1bGU6bm9uemVybyIvPjwvc3ZnPg%3D%3D&labelColor=fff"></a>
+</p>
+
+[文档](https://docs.ncatbot.xyz) | [许可证](LICENSE) | [QQ群](https://qm.qq.com/q/AmdNUkSxFY) | [插件社区](https://www.ityzs.com/)
+
+NcatBot 是基于 OneBot11 协议的 Python SDK，它提供了一套方便易用的 Python 接口，用于开发 QQ 机器人。
+
+</div>
+
+
+## 如何使用
+
+
+- 认真阅读本项目[文档](https://docs.ncatbot.xyz)
+- 使用 Docker [部署](https://github.com/ncatbot/NcatBot-Docker)。
+
+## 欢迎来玩
+
+[是 QQ 群哦喵~](https://qm.qq.com/q/L6XGXYqL86)
+
+## 获取帮助
+
+-- 遇到任何困难时，请先按照以下顺序尝试解决：
+
+  1. **仔细阅读**[文档](https://docs.ncatbot.xyz).
+  2. 询问 [Gemini](https://gemini.google.com/), [Kimi](https://kimi.ai) 等人工智能.
+  3. 搜索本项目的 [Issue 列表](https://github.com/ncatbot/ncatbot/issues).
+-- 如果以上方法都无法解决你的问题，那么：
+  1. 在 [Issue 列表](https://github.com/ncatbot/ncatbot/issues) 发 Issue 求助。
+  2. [进群](https://qm.qq.com/q/L6XGXYqL86)提问。
+
+## 使用限制
+
+1. **严禁将本项目以任何形式用于传播淫秽、反动或暴力等信息。**
+2. **未经授权，禁止将本项目以任何形式用于盈利。**
+
+## 致谢
+
+感谢 [NapCat](https://github.com/NapNeko/NapCatQQ) 提供底层接口 | [IppClub](https://github.com/IppClub) 的宣传支持 | [Fcatbot](https://github.com/Fish-LP/Fcatbot) 提供代码和灵感。
+
+感谢 [林枫云](https://www.dkdun.cn/) 提供服务器支持。
+
+## 参与贡献
+
+如果在你使用过程中遇到问题，或有任何建议，欢迎在 [GitHub Issues](https://github.com/ncatbot/ncatbot/issues) 中反馈。
+
+欢迎给本 Repo 贡献代码！请先阅读 [贡献指南](CONTRIBUTING.md)。
+
+感谢你的支持！
+
+
+<div align="center">
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=ncatbot/ncatbot&type=Date)](https://www.star-history.com/#ncatbot/ncatbot&Date)
+
+## 贡献者们
+
+<a href="https://github.com/ncatbot/ncatbot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ncatbot/ncatbot" />
+</a>
+
+</div>