Project Introduction

Lingchu Bot

Lingchu Bot documentation overview

Lingchu Bot is an application-side management bot project based on NoneBot2. It organizes core capabilities as plugins and currently focuses on group management, command handling, configuration, local storage, and asynchronous data access.

Project status

This project is still in pre-alpha / development. Code, configuration, command behavior, and documentation may continue to change. Do not treat the current interfaces as stable production APIs.

User Guide

Understand project status, runtime setup, and command capabilities

Quick Start

Install dependencies and choose plugin loading or Docker runtime

Developer Guide

Understand project structure, architecture, and development workflow

Project Policy

Contribution, security, license, and media redaction requirements

Current capabilities

A core plugin entrypoint based on NoneBot2.
pyproject.toml declarations for local plugin directories, available adapters, and NoneBot dependency plugins.
Only one adapter is enabled for the QQ platform at a time; the default is ~onebot.v11. Milky, QQ, and OneBot V12 are deprecated and fully removed.
Currently implemented and tested QQ group management handlers: member mute/unmute, whole-group mute/unmute, group profile updates, member management, announcements, kicks, and leaving a group.
Optional message storage for received events, processing status, bot lifecycle events, and platform API call summaries, with unknown adapters grouped under the unknown platform.
JSON5 local storage, NoneBot localstore path management, and ORM CRUD helpers.
gettext / Babel internationalization helpers with zh_CN and en_US catalogs.
Developer tooling for general commands, prek hooks, tests, and CI checks.
Extension room for later cross-platform and non-group-management features.

Repository links

Source code: https://github.com/xinvxueyuan/lingchu-bot
Contribution guide: https://github.com/xinvxueyuan/lingchu-bot/blob/main/CONTRIBUTING.md
Security policy: https://github.com/xinvxueyuan/lingchu-bot/blob/main/SECURITY.md