欢迎来到 Rubirai wiki！

_{Currently, the English version of this documentation is not planned to have.}

Rubirai 是 mirai-api-http 插件的 Ruby 类库。它实现了这个插件的大多数接口，并且提供了事件、消息类型。Rubirai 还提供了可阻塞的事件监听机制（通过每一段时间调用获取消息的接口）。

先安装 mirai-api-http 插件并且配置它的 setting.yml 文件。如果你只有一个机器人账户登录在 mirai 上，那你可以开启 simgleMode。

注意：你必须开启 Http Adapter。

rubirai 已经发布至 RubyGems 与 Github Packages。

注意把下面的 [version] 替换成你想要的版本。目前最新的版本是

当然，你可以使用（并且我推荐你使用）bundler 安装 gems。

gem 'rubirai', '~> [version]'

source "https://rubygems.pkg.github.com/shimogawa" do
  gem "rubirai", "~> [version]"
end

gem install rubirai --version "[version]"

gem install rubirai --version "[version]" --source "https://rubygems.pkg.github.com/shimogawa"

Bundler 提供了引用源代码的方式引用 gem 包。你可以在 Gemfile 中加入这行：

gem 'rubirai', :git => 'git://github.com/Shimogawa/rubirai.git'

Ruby Doc

因为 Github Pages 在国内访问经常抽风，所以可以访问 RubyDoc 阅读。

中文文档看情况会写，但是你可以善用翻译功能。

详情请见快速入门。

也可以看一些例子。

API 接口名称有的和 mirai-api-http 的接口名称略微不同，并且遵循 Ruby 格式规范 rubocop，所有方法、字段名使用蛇形命名法。调用的时候要好好用到代码提示哦。