DOCSEARCHbyAlgolia
Submit Docs

GraiaX Documentation

website·Indexed 32 days ago

https://graiax.cn

A comprehensive guide for building bots using the Graia community ecosystem. It covers the installation and configuration of Mirai, Python environments, and IDEs, alongside detailed tutorials on using Graia Saya for modular bot development, message chain handling, and message parsing with tools like Alconna and Twilight. The documentation also introduces community projects such as GraiaX Playwright, GraiaX TextToImage, and Saya Util.

Tokens
33.1K
Snippets
169
Records
226
Agent score
63%

What's inside GraiaX

  1. Overview of Ariadne and Graia Project

    Ariadne is a Python QQ automation framework based on Mirai API HTTP v2. It is a sub-project of the Graia Project. While other frameworks like Application Mirai (deprecated) and Avilla (WIP) exist within the project, Ariadne is the primary framework used for current development.

  2. Overview of Basic Message Chain Parsers

    Basic message chain parsers are located in graia.ariadne.message.parser.base. They are used to detect specific patterns in a MessageChain and can be used as decorators to trigger event handlers only when a match is found.

  3. Overview of Twilight message matching in Ariadne

    Twilight is a standard message chain matching tool used in Ariadne (specifically version ^0.7.0). It acts as a Dispatcher (inheriting from BaseDispatcher); when used in a ListenerSchema, it parses the incoming message chain. If the matching fails, it throws an ExecutionStop error, preventing the registered handler function from being called.

  4. Introduction to BroadcastControl (BCC)

    BroadcastControl (BCC) is used for constructing user interfaces and event broadcasting in Ariadne. It relies on two primary elements:

    • Dispatcher: Parameter parsers (e.g., event listeners and message chain parsers).
    • Decorator: Parameter decorators.

    Any class instance that declares a Dispatcher can be used as an event broadcast. All predefined Ariadne events are located in graia.ariadne.event.

  5. Overview of Graia Saya modular framework

    Graia Saya is a modular management framework for Graia Ariadne bots. It allows developers to split bot functionality into separate modules (files or folders), making the codebase easier to maintain and allowing features to be added or removed by simply copying and pasting files.

  6. Overview of Graia Scheduler

    Graia Scheduler is a simple, asyncio-based scheduled task library designed for ease of use and clean code integration within GraiaX bot projects.

  7. Overview of the Ariadne Framework

    Ariadne is a sub-project of the Graia Project. It is an elegant and complete Python QQ automation framework based on the Mirai API HTTP v2. It serves as the primary framework used in the Graia community for building QQ bots.

  8. Overview of Git and Version Control Systems (VCS)

    Git is a Version Control System (VCS) used to manage code changes. It allows developers to take snapshots of their project (known as Commits), enabling them to track modifications, compare changes, and revert to previous states. This prevents loss of work when experimental changes introduce bugs.

  9. Overview of Graia Community Projects

    The Graia Community provides several officially released projects for developers, including specialized integrations for FastAPI, Playwright, and image generation tools.

  10. Overview of Graia and community projects

    The Graia ecosystem includes several key projects for plugin management, configuration, and utility integration:

    • Saya: A plugin (module) manager specifically for Graia.
    • Kayaku: A comprehensive configuration file solution.
    • GraiaX FastAPI: A utility for calling FastAPI directly within Saya modules.
    • GraiaX Playwright: A boundary tool that starts Playwright upon Graia project launch and allows direct calls within Saya modules.
    • GraiaX Text2Img Playwright: A tool that converts text-based formats like HTML and Markdown into images using Playwright.

  11. Understand the Ariadne and Mirai architecture

    Ariadne does not connect to QQ servers directly. It requires a specific stack to function:

    1. Mirai: A high-performance QQ protocol library.
    2. Mirai Console: A plugin-based development platform based on Mirai.
    3. Mirai Api Http (mah): A Mirai Console plugin that provides the HTTP interface for Ariadne to communicate with Mirai.
    4. Mirai Console Loader: The launcher for Mirai and Mirai Console.

    To use Ariadne, you must first configure Mirai's automatic login and the mirai-api-http plugin.

  12. Understand the Ariadne and Mirai Architecture

    Ariadne does not connect to QQ servers directly. It requires a specific stack to function:

    1. Mirai: A high-performance QQ protocol library.
    2. Mirai Console: A plugin-based extensible development platform based on Mirai.
    3. Mirai Api Http (mah): A Mirai Console plugin that provides the interaction layer between Ariadne and Mirai.
    4. Mirai Console Loader: The launcher for Mirai and Mirai Console.

    To use Ariadne, you must first configure Mirai's automatic login and the mirai-api-http plugin.