Gensokyo

Documentation · Download · Get ​​Started · Contribute

Project homepage:gensokyo.bot

Quote

• tencent-connect/botgo : This project refers to this project and made some changes.

introduce

gensokyo is compatible with OneBot-v11 and has made some extensions based on it. Please see the OneBot documentation for details.

Gensokyo Documentation (Under Construction): Getting Started

Can convert official websocket and API to onebotv11 standard,

Supports connection to koishi, nonebot2, trss, zerobot, MiraiCQ, hoshino..

Supports connection with tata, Paimon, Fried Hair, Sanae, Yobot...

Supports connection to Mirai (Overflow)...

Can be connected and used with projects that support onebotV11 adapter.

This enables plug-in development and user developers to reuse plug-ins and user experiences from the past ecosystem without re-development.

Continuously improving...Communication group: 196173384

Welcome to test, ask any questions about use, we will answer any questions and help if you have any difficulties~

Expand the folding bar on the left side of the Gensokyo temporary document. The temporary document contains markdown definitions, additional API documents, etc.

The document will be made independent in the future. Because the Yuque document can be viewed publicly without logging in and requiring a VIP, it will be temporarily placed in my robot document. The temporary documentation also contains a complete compilation tutorial for Gensokyo.

special thanks

• mnixry/nonebot-plugin-gocqhttp : This project uses the front-end written by mnixry and implements its corresponding back-end API based on the qq official API.
• Special thanks to dk 盾for kindly sponsoring server resources

interface

• HTTP API
• Reverse HTTP POST
• Forward WebSocket
• ReverseWebSocket

Expand support

Expansion API can be viewed in the documentation

• Connect multiple ws addresses
• Group channels into virtual events
• Virtualize private messages into channels or group events
• webui, you can modify the configuration, view the channel list, and send information in webui
• Instruction blacklist and whitelist for easy review
• Automatic URL conversion (bring your own domain name)
• Customizable image compressionimage bed service
• editable database
• Support array and information segment
• Text, pictures, voice, video, MD, supports multiple types of sending
• Supports global, channel, channel private chat, group, group private chat
• If active information fails, it will automatically turn to passive to improve the reliability of information transmission.
• Support the group list group member API ahead of official support
• Perfect reconnection, robust connection capabilities.
• Support [CQ:markdown,data=] Markdown sending
• markdown文档
• Keep updating~

accomplish

CQ code implemented

CQ code that complies with OneBot standards

CQ code	Function
[CQ:face]	[QQ emoticon]
[CQ:record]	[voice]
[CQ:video]	[Short video]
[CQ:at]	[@someone]
[CQ:share]	[Link sharing]
[CQ:music]	[Music sharing] [Music custom sharing]
[CQ:reply]	[reply]
[CQ:forward]	[Merge and forward]
[CQ:node]	[Merge forwarding nodes]
[CQ:xml]	[XML message]
[CQ:json]	[JSON message]

todo,under construction

Extended CQ codes and CQ codes that are slightly different from the OneBot standard

Expand CQ code	Function
[CQ:image]	[picture]
[CQ:poke]	[Poke it]
[CQ:node]	[Merge and forward message nodes]
[CQ:markdown]	[markdown card sending and receiving]
[CQ:tts]	[text to speech]

API implemented

API compliant with OneBot standards

API	Function
/send_private_msg√	[Send private message]
/send_group_msg√	[Send group message]
/send_guild_channel_msg√	[Send channel message]
/send_msg√	[Send message]
/delete_msg	[Withdraw information]
/set_group_kick	[Group kicking people]
/set_group_ban√	[Group single ban]
/set_group_whole_ban√	[Block all members of the group]
/set_group_admin	[Group Settings Administrator]
/set_group_card	[Set group business card (group remarks)]
/set_group_name	[Set group name]
/set_group_leave	[Exit group]
/set_group_special_title	[Set group exclusive title]
/set_friend_add_request	[Handle friend request]
/set_group_add_request	[Processing requests/invitations to join the group]
/get_login_info√	[Get login number information]
/get_stranger_info	[Get stranger information]
/get_friend_list√	[Get friend list]
/get_group_info√	[Get group/channel information]
/get_group_list√	[Get group list]
/get_group_member_info√	[Get group member information]
/get_group_member_list√	[Get group member list]
/get_group_honor_info	[Get group honor information]
/can_send_image√	[Check if pictures can be sent]
/can_send_record	[Check if voice can be sent]
/get_version_info√	[Get version information]
/set_restart√	[Restart gensokyo]
/.handle_quick_operation	[Perform quick actions on events]

Extended APIs and APIs that are slightly different from the OneBot standard

Expand API	Function
/set_group_portrait	[Set group avatar]
/get_image	[Get picture information]
/get_msg	[Get news]
/get_forward_msg	[Get merged and forwarded content]
/send_group_forward_msg√	[Send combined forwarding (group)]
/.get_word_slices	[Get Chinese word segmentation]
/.ocr_image	[Image OCR]
/get_group_system_msg	[Get group system messages]
/get_group_file_system_info	[Get group file system information]
/get_group_root_files	[Get the group root directory file list]
/get_group_files_by_folder	[Get the group subdirectory file list]
/get_group_file_url	[Get group file resource link]
/get_status√	[get status]

Event implemented

Events that comply with OneBot standards (some Events report several more fields than OneBot standards, which does not affect use)

event type	Event
message event	[Private chat information]√
message event	[Group Message]√
notification event	[Group file upload]
notification event	[Change of group administrator]
notification event	[Reduction in group members]
notification event	[Group members increased]
notification event	[Group ban]
notification event	[Friend added]
notification event	[Group message withdrawn]
notification event	[Friend message withdrawn]
notification event	[Poke in the group]
notification event	[Group Red Envelope Luck King]
notification event	[Group member honor change]
request event	[Friend request]
request event	[Group request/invitation]

Expand Event

event type	Expand Event
notification event	[Poke from a friend]
notification event	[Poke in the group]
notification event	[Group member business card update]
notification event	[Offline file received]

AboutISSUE

The following ISSUE will be closed directly

• Report a bug without using Template
• Ask a known issue
• Can't find the point of the question
• Repeat question

Please note that the developers are not obligated to respond to your questions. You should have basic questioning skills.
For information on how to ask questions, read The Wisdom of Asking

performance

10MB memory occupied port staggered, can be opened more than one, stable operation without error