Skip to content

Latest commit

 

History

History
119 lines (85 loc) · 4.82 KB

README_en.md

File metadata and controls

119 lines (85 loc) · 4.82 KB

AmyAlmond Chatbot

License Python Version GitHub Stars Build Status Version

English | 简体中文

⭐ Your go-to chatbot for supercharging group chats ⭐

Features • Screenshots • Docs • Contribute • License

Features

AmyAlmond is an LLM API-powered smart chatbot designed to seamlessly integrate into QQ groups and channels.

By leveraging LLM API, AmyAlmond offers context-aware intelligent responses, enhancing user interaction and supporting long-term memory management. Whether it’s automating replies or boosting user engagement, she handles complex conversations like a breeze.

  • 🌈 She uses the LLM API to generate human-like responses based on conversation context, with customizable prompts.
  • 💗 Integrated with QQ’s official Python SDK, so you don’t have to worry about being blocked.
  • 🔥 Automatically recognizes and remembers user names, providing a personalized interaction experience.
  • 🧠 Equipped with long-term and short-term memory, she can record and recall important information, ensuring continuity in conversations.
  • 🐳 Administrators can control her behavior with specific commands.
  • ⭐ Full configuration hot-reloading reduces restart times, boosting efficiency.
  • 🪝 Detailed logs and code comments make debugging and monitoring a breeze.

Curious about the results?

效果图_对话注册
效果图_记忆上下文

Installation/Deployment/Development

Documentation Database
Click the image to jump in

Contributing

We'd love to have you on board! Whether it’s adding new features, fixing bugs, or improving documentation, your contributions are welcome!

Branch Strategy

We follow the Git Flow branching model:

  • main: The stable branch, always ready for production.
  • develop: The development branch, where all new features are integrated.
  • feature/: Feature branches, created from develop, merged back once the feature is complete.
  • hotfix/: Hotfix branches, used to quickly patch bugs, merged back into main and develop.

How to Contribute

  1. Fork this repo
    Fork the project to your GitHub account.

  2. Create a branch
    Create a new feature branch for your changes:

    git checkout -b feature/AmazingFeature

  3. Commit your changes
    Commit your code with clear and concise messages:

    git commit -m 'Add some AmazingFeature'

  4. Push to GitHub
    Push your branch to GitHub:

    git push origin feature/AmazingFeature

  5. Create a Pull Request
    Create a Pull Request on GitHub, describing your changes and their impact.

License

License: MPL 2.0

AmyAlmond is licensed under the MPL 2.0 License. You are free to use, modify, and distribute this project, but you must open source any modified versions and retain the original author's copyright notice.

Disclaimer

This project is for learning and research purposes only. The developers are not responsible for any consequences resulting from the use of this project. Please ensure compliance with relevant laws and respect others' intellectual property rights when using this project.

Roadmap

Check out our Project Board for the latest updates!

q(≧▽≦q) You've read this far—how about dropping us a ⭐️?

amyalmond_bot Chart