Skip to content

AIcarusDev/AIcarusForQQ

Repository files navigation

AIcarusForQQ

QQ AI Bot with LLM integration (Restructured).

Structure

  • src/: Core source code (main.py, adapters, handlers)
  • config/: Configuration files (config.yaml, schemas)
  • data/: Runtime data (Persona, SQLite DB, Self Image)
  • logs/: Application logs
  • archive/: Legacy code (e.g. provider_old.py)

Quick Start (Windows)

Double-click start.bat to launch the bot.

  • First Run: It will guide you to set up a Python environment (create venv, use Conda, or system Python) and install dependencies automatically.
  • Subsequent Runs: It remembers your choice and launches immediately.

To reset the environment configuration:

start.bat --reset

Configuration

1. API Keys (Security)

Create a .env file in the project root (copied from .env.example). Do not commit this file.

cp .env.example .env
# Edit .env and fill in your API keys (e.g. GEMINI_API_KEY)

2. General Settings

  • Default Config: The project comes with a safe default at config/config.yaml.

  • User Overrides: To customize settings (e.g., model name, temperature, bot name), create a file named config_user.yaml in the project root.

    Any settings defined in config_user.yaml will override config/config.yaml. This file is git-ignored, keeping your personal tweaks private.

    Example config_user.yaml:

    bot_name: "Shadow"
    model: "gemini-1.5-pro-latest"
    timezone: "Asia/Tokyo"

3. Persona

Edit the bot's personality in data/persona.md.

Development

Any settings defined here will override config/config.yaml. This file is git-ignored, so your secrets are safe. 3. Persona: Edit bot persona at data/persona.md.

Development

To run manually without start.bat:

# Activate your environment
# Ensure requirements are installed
python run.py

This launcher script adds src/ to sys.path and starts the application.

License

This project is licensed under the GNU Affero General Public License v3.0.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors