cqhttp.Cyan

Cyan---青

使用本插件你能做到什么？

写一个复读机
写一个点歌机器人
写一个自定义回复机器人
管理多个QQ号，进行类似“负载均衡”的操作
进行任何使用C#语言能够做到的事。（写一个QQ客户端（误（律师函警告

快速上手

1.搭建一个酷Q实例并开启事件上报

请参考
酷Q官网
 cqhttp插件文档

2.创建一个 .NET console项目

在https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial#install获取.NET工具包
在任意目录下创建项目文件夹，并在cmd中执行

dotnet new console -o [给项目起的名字]

3.添加nuget包

在项目目录下执行

dotnet add package cqhttp.Cyan
dotnet restore

4.掌握一定的C#语言基础，并在Program.cs中编写bot逻辑

using cqhttp.Cyan;
using cqhttp.Cyan.Instance;
namespace YourNS {
    class Program {
        static void Main(string[] args) {
            //CQApiClient client = CQWebsocketClient(
            CQApiClient client = CQHTTPClient (
                //accessUrl: "ws://domain:port/api",
                accessUrl: "http://domain:port/path",
                accessToken: "your_token",
                //listenUrl: "ws://domain:port/events
                listen_port: 8080,
                //注意websocket无secret参数
                secret: "your_secret"
            )
            Console.WriteLine(
                $"QQ:{client.self_id},昵称:{client.self_nick}"
            );
            //client构造后会发送一条get_login_info请求，则可以通过
            //判断是否成功获取登陆的账号的QQ与昵称判断API是否可访问
            client.OnEvent += (client, e) => {
                //process (CQEvent e)
                return new CQEmptyResponse ();
            };
            client.SendTextAsync(
                MessageType.private_,
                12345678,
                "一条文字消息"
            );
            Console.ReadLine();
        }
    }
}

在Examples文件夹下有更详细的示例

https://github.com/frankli0324/cqhttp.Cyan/tree/master/src/_Examples

对应关系

cqhttp中的概念	对应本项目中的类型	所处在的命名空间
消息	`Message`	.Messages
消息段	`Element`	.Messages.CQElements(.Base)
事件	`CQEvent`	.Events.CQEvents(.Base)
事件响应	`CQResponse`	.Events.CQResponse(.Base)
Api调用	`ApiRequest`	.ApiCall.Requests(.Base)
Api响应	`ApiResponse`	.ApiCall.Responses(.Base)

消息的发送与接收

本项目中发送与接收到的消息同为Message类型。

消息接收

在事件处理函数中可通过(e is MessageEvent)判断收到的是否为消息事件，如下：

static void Main() {
    var client = new HTTPApiClient(...);
    client.OnEvent += HandleEvent;
}
static CQResponse HandleEvent(CQApiClient api, CQEvent e) {
    if(e is MessageEvent) {
        return HandleMessage (
            (e as MessageEvent).message
        )
    }
}

消息之间可以进行相等判断、相加操作

Message a = new Message(new ElementText("asdf"), new ElementFace(4));
Message b = new Message(new ElementText("asdf"));
b += new ElementFace(4);
Console.WriteLine(a == b);//True
Message c = new Message(new ElementText("asdf"), new ElementFace(3));
Console.WriteLine(a == c);//False
a + c;//asdf[CQ:face, id=4]asdf[CQ:face, id=3]

....也就是说....你可以很轻松地写一个复读鸡emmmmmmm

消息发送

可以自己构建需要发送的消息，也可以选择直接发送文本消息，亦或是发送定义好的常用消息

目前可用的常用消息:

MessageShake(), 戳一戳, 空构造
~~MessageText(), 纯文本~~, 由于提供了发送纯文本消息的函数，故不需要
MessageOnlineImage(), 在线图片, 通过url构造
MessageShare(), 分享卡片, 通过URL, 分享标题, 分享简介与分享图片的URL构造
MessageAnonymous(), 匿名消息, 在Message构造的基础上多了ignore参数

static void Main() {
    var client = HTTPApiClient(...);
    //////////////////////
    client.SendTextAsync("text");
    //////////////////////
    client.SendMessageAsync(
        MessageType.private_/group_/discuss_,
        qq号/群号/讨论组号,
        new Message (
            new ElementText("part1"),
            new ElementFace(1),//1-170
            new ElementText("part2")
        )
    );
    //////////////////////
}

目前可用的Element类型:

ElementEmoji(int id)
ElementFace(int id)
ElementImage(string url,bool useCache = false)
........................(byte[] resourse, bool useCache = false)
ElementRecord(string url,bool useCache = false)
..........................(byte[] resourse, bool useCache = false)
ElementMusic(string type, string keyword)其中type为163,qq,xiami之一
ElementShake()*
ElementShare()*
ElementAnnonymous()*

星标Element最好使用CommonMessages中的对象构造

Facts

CQApiClient的参数

CQHTTPClient的参数中除accessUrl外皆为可选参数，即你可以实例化一个“仅发送API请求”的Client对象。

多实例

你可以实例化多个Client对象以连接到不同的酷Q实例，以完成各种*操作

using cqhttp.Cyan.Utils

Utils命名空间中有很多好用的工具
比如

持久化存储群列表与群员信息GroupTable,

使用方式: 对于任意CQApiClient对象i,将一个GroupTable对象赋给i.groupTable后,在这个Client示例调用GetGroupList API时将自动向此对象记录获得的群组信息

持久化存储两分钟内发送的消息MessageTable,
还有各种用于转换消息用的函数Convert.*(如Convert.ToEmoji(id)可以将QQ表情转换为相似的Emoji，便于发送奇怪的表情)

文档

http://www.std-frank.club/cqhttp.Cyan

事件列表(对应CQEvent)

消息事件(继承于MessageEvent)

PrivateMessageEvent
GroupMessageEvent
DiscussMessageEvent

群通知(继承于GroupNoticeEvent)

GroupAdminEvent 群管理员变动
GroupUploadEvent 群文件上传
GroupMemberChangeEvent 群成员变动

另有FriendAddEvent与GroupNoticeEvent同继承于NoticeEvent

请求事件(继承于RequestEvent)

GroupAddRequestEvent 邀请加群
FriendAddRequestEvent 添加好友

需要作出回应(....不回应也罢)

事件回应列表(对应CQResponse)

通用回应

EmptyResponse 默认

消息事件回应(继承于CQReplyMessageResponse)

PrivateMessageResponse 快速回复私聊消息
GroupMessageResponse 快速回复群消息
DiscussMessageResponse 快速回复讨论组消息

请求事件回应

FriendAddReqestResponse 加好友
GroupAddRequestResponse 加群

hd2y / cqhttp.Cyan