User Guide Overview

User Guide Overview

Lingchu Bot is currently best suited for development, testing, and early trials. The documentation describes capabilities that are visible in the repository and does not promise platform behavior that has not been verified.

What you can expect

• A bot project skeleton based on NoneBot2.
• A core plugin package that can be loaded as a local NoneBot plugin directory.
• A set of currently implemented and tested QQ group management command handlers.
• Configuration, storage, and database helper modules for later feature expansion.
• Mutually exclusive QQ adapter selection: OneBot V11 by default, with explicit switching through LINGCHUAdapter.
• Optional message storage for events, processing status, bot lifecycle events, and platform API call summaries.
• Extension room for later cross-platform and non-group-management features.
• Runtime feedback translation based on gettext, currently with Simplified Chinese and English catalogs.

What you need

• Python 3.13.
• uv.
• A usable NoneBot runtime environment plus account, network, and connection settings for the enabled adapter.
• Basic familiarity with NoneBot configuration files and adapter connection settings.

Recommended reading order

1. Quick Start
2. Commands and Group Management
3. Configuration
4. Troubleshooting

Current limits

• The project is still in pre-alpha / development.
• The repository root currently does not ship a committed local bot.py; the Docker build generates a runtime /tmp/bot.py, and existing NoneBot projects can load src/plugins according to pyproject.toml.
• QQ group management is the currently implemented and tested business path. The default adapter is OneBot V11. Milky, QQ, and OneBot V12 are deprecated and fully removed.
• The adapter selected by LINGCHUAdapter must be loaded by NoneBot; extra registered same-platform adapters are treated as disabled.
• Other platforms and non-group-management capabilities depend on later implementation and tests.
• The command surface is still small. The docs only list capabilities confirmed in the current repository.
• Runtime i18n currently covers group management feedback text. It does not mean all command trigger words are localized.