RainyBot
主页交流论坛社区群聊GitHub
  • 📖文档主页
    • ⚙️安装与运行
    • 🪄开始使用
    • 🔮插件开发
      • 事件注册与处理
      • 关键词注册与处理
    • 🚀更新日志
  • 📦RainyBot API
    • 类: ActionEvent
    • 类: AppMessage
    • 类: AtAllMessage
    • 类: AtMessage
    • 类: Bot
    • 类: BotAPI
    • 类: BotCodeMessage
    • 类: BotEvent
    • 类: BotJoinGroupEvent
    • 类: BotLeaveGroupEvent
    • 类: BotMuteEvent
    • 类: BotOfflineEvent
    • 类: BotOnlineEvent
    • 类: BotPermChangeEvent
    • 类: BotReloginEvent
    • 类: BotRequestResult
    • 类: BotUnmuteEvent
    • 类: CacheMessage
    • 类: Console
    • 类: CoreAPI
    • 类: DiceMessage
    • 类: Event
    • 类: EventAPI
    • 类: FaceMessage
    • 类: FileMessage
    • 类: FlashImageMessage
    • 类: ForwardMessage
    • 类: ForwardMessageNode
    • 类: ForwardMessageNodeList
    • 类: FriendEvent
    • 类: FriendInputStatusChangeEvent
    • 类: FriendMessageEvent
    • 类: FriendNickChangeEvent
    • 类: FriendRecallEvent
    • 类: GifImage
    • 类: Group
    • 类: GroupAPI
    • 类: GroupAllowAnonyChatEvent
    • 类: GroupAllowConfessTalkEvent
    • 类: GroupAllowInviteEvent
    • 类: GroupAnnounce
    • 类: GroupAnnounceChangeEvent
    • 类: GroupAnnounceInfo
    • 类: GroupAnnounceInfoList
    • 类: GroupBotEvent
    • 类: GroupConfig
    • 类: GroupEvent
    • 类: GroupInviteRequestEvent
    • 类: GroupList
    • 类: GroupMember
    • 类: GroupMemberEvent
    • 类: GroupMemberList
    • 类: GroupMessageEvent
    • 类: GroupMuteAllEvent
    • 类: GroupNameChangeEvent
    • 类: GroupRecallEvent
    • 类: HttpRequestResult
    • 类: ImageMessage
    • 类: JsonMessage
    • 类: MarketFaceMessage
    • 类: Member
    • 类: MemberAPI
    • 类: MemberHonorChangeEvent
    • 类: MemberJoinEvent
    • 类: MemberJoinRequestEvent
    • 类: MemberLeaveEvent
    • 类: MemberList
    • 类: MemberMuteEvent
    • 类: MemberNameChangeEvent
    • 类: MemberPermChangeEvent
    • 类: MemberProfile
    • 类: MemberTitleChangeEvent
    • 类: MemberUnmuteEvent
    • 类: Message
    • 类: MessageAPI
    • 类: MessageChain
    • 类: MessageEvent
    • 类: MusicShareMessage
    • 类: NewFriendRequestEvent
    • 类: NudgeEvent
    • 类: OtherClient
    • 类: OtherClientEvent
    • 类: OtherClientMessageEvent
    • 类: OtherClientOfflineEvent
    • 类: OtherClientOnlineEvent
    • 类: Plugin
    • 类: PokeMessage
    • 类: QuoteMessage
    • 类: RainyBotAPI
    • 类: RequestEvent
    • 类: RoleAPI
    • 类: SourceMessage
    • 类: StrangerMessageEvent
    • 类: TempMessageEvent
    • 类: TextMessage
    • 类: Utils
    • 类: VoiceMessage
    • 类: XmlMessage
  • Godot API
由 GitBook 提供支持
在本页
  • 目录结构
  • 管理插件
  • 尝试示例插件
  • 使用控制台指令
  • 探索菜单功能

这有帮助吗?

在GitHub上编辑
  1. 文档主页

开始使用

先来认识一下RainyBot的一些常用功能吧~

上一页安装与运行下一页插件开发

最后更新于2年前

这有帮助吗?

如果您已按照前面的说明完成配置并成功运行RainyBot,那么您现在应该已经准备好使用RainyBot的各种功能了~

下面,将为您简单介绍一些RainyBot使用层面的常用功能,相关内容请参见后续章节。

目录结构

在开始之前,让我们先简单了解一下RainyBot的目录结构

📂 RainyBot根目录
├── 📂 .godot - 储存各类资源的优化版本,请不要手动删除或修改
├── 📂 adapters - 储存各个协议后端的相关文件,请不要随意删除或修改
|   └── 📂 mirai - Mirai协议后端相关文件
├── 📂 cache - 储存RainyBot与插件运行过程中的各类缓存,将在关闭时自动清空
|   └── 📜 <插件ID>.rca - 某个插件的缓存数据
├── 📂 config - 储存RainyBot与插件的各类配置文件
|   └── 📜 <插件ID>.json - 某个插件的配置文件
├── 📂 data - 储存RainyBot与插件的各类数据
|   └── 📜 <插件ID>.rdb - 某个插件的数据库文件
├── 📂 libs - RainyBot运行所需的各类核心文件,请不要随意修改
├── 📂 logs - 储存RainyBot运行时的控制台日志
├── 📂 plugins - 储存各个插件及其所需的文件
├── 📜 project.godot - 储存了RainyBot运行所需的各类核心参数,请不要随意修改
├── 📜 RainyBot(.exe) - RainyBot的主程序可执行文件

管理插件

得插件者得天下,RainyBot本身不具备诸如聊天,签到一类的具体功能,但其提供了丰富易用的API以供插件实现各类所需功能;通过各个插件的组合使用,您可以轻松打造出自己梦想中的专属Bot~

在RainyBot中,您可以通过插件管理器GUI,或控制台指令来管理各个插件。若要启动插件管理器,请在主菜单选择插件->插件管理器即可。若要通过指令管理插件,请在控制台中输入/help plugins来查看插件管理相关指令

安装/加载插件

插件的安装非常简单,您可以在插件菜单或插件管理器中选择打开插件文件夹,将插件各类文件(至少为一个.gd文件) 放入插件文件夹后,通过插件管理器刷新插件列表,选中新出现的对应文件,点击重新加载即可。您也可以通过/plugins load <文件名>指令,或重载所有插件选项来加载新的插件

有些插件可能依赖于其他插件,对于此类情况,请确保要加载的插件所依赖的插件存在于插件文件夹中,且可被正常加载,否则该插件将会加载失败

需要注意的是,对于包含了各类资源及场景的插件(如图像资源,字体资源等),请在将其各个文件放入插件目录后,在插件菜单中选择重新导入所有资源来让RainyBot初始化插件包含的各个资源,否则插件或其场景可能会无法正常加载或工作。

重载/卸载/删除插件

与安装插件类似,您可以通过plugins指令或插件管理器界面来重载/卸载/删除各个插件。但是,如果某个正在操作的插件是其他插件的依赖,则操作将会失败;您需要先卸载依赖此插件的其他插件,才能对此插件进行操作。

除对单个插件进行操作外,您还可以批量重载/卸载所有插件。在批量操作时,RainyBot将自动处理依赖关系,因此您无需按顺序手动卸载某些插件。

新建/编辑插件

RainyBot内置了一个功能完善的插件编辑器,拥有基本的语法高亮/自动补全/错误检查等功能,您可以通过插件管理器或plugins指令来新建/编辑一个插件。编辑时将会自动启动内置的插件编辑器并加载要编辑的插件。编辑完成后,您可以在插件编辑器中选择保存或保存并重载插件。

查看插件信息

您可以通过插件管理器或plugins指令来查看某个插件的各种信息,如名称,ID,作者,版本,依赖,描述等。对于已加载的插件,您还可以通过插件管理器来查看它的事件/关键词/控制台命令注册列表(暂不支持指令)。

管理插件数据

除查看信息外,您还可以通过插件管理器或plugins指令来查看或管理某个插件的各类数据,如数据库/缓存/配置文件等。目前暂时仅支持通过指令来查看或管理插件数据库的各类数据,因此建议使用插件管理器来进行更直观全面的管理。

尝试示例插件

使用控制台指令

RainyBot预置了大量便捷的控制台指令,以便您直接进行各种操作。同时,部分插件可能也会注册一些控制台指令用于实现各类功能。若要查看所有已注册的控制台指令,请在控制台输入/help即可打印所有指令列表。

探索菜单功能

除上方所述内容外,您还可以在RainyBot控制台页面的各个菜单中找到其余各项便捷功能。请大胆的去尝试它们,以便在需要时知道如何操作。

关于插件开发的具体介绍及教程,请参见后续的章节。

一时半会找不到想要用的插件,或者想要测试RainyBot是否正常运行?您可以示例插件,按照上述方法进行安装即可。

📖
🪄
插件开发
插件开发
在此处下载
插件管理器GUI
未加载的插件
重新导入所有资源
已加载的插件
插件编辑器
插件注册列表
插件数据列表
RainyBot控制台
主菜单