Skip to content

Commit

Permalink
Merge 73ba495 into 354f52a
Browse files Browse the repository at this point in the history
  • Loading branch information
koi-chan committed Jul 24, 2019
2 parents 354f52a + 73ba495 commit 10bb2d6
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
汎用 IRC ボット RGRB
汎用チャットボット RGRB
====================

[![Build Status](https://travis-ci.org/cre-ne-jp/rgrb.svg?branch=master)](https://travis-ci.org/cre-ne-jp/rgrb)
[![Coverage Status](https://coveralls.io/repos/cre-ne-jp/rgrb/badge.svg?branch=master&service=github)](https://coveralls.io/github/cre-ne-jp/rgrb?branch=master)

RGRB は Ruby で実装されている汎用 IRC ボットです。プラグイン方式により柔軟な拡張が可能です。
RGRB は Ruby で実装されている汎用 IRC/Discord ボットです。プラグイン方式により柔軟な拡張が可能です。

動作環境
--------
Expand Down Expand Up @@ -60,11 +60,14 @@ gem install mailcatcher
設定
----

[config/rgrb.yaml](config/rgrb.yaml) を編集して設定します。複数の設定を使う場合は、このファイルをコピーして config/ に設置します。
IRC ボット用および Discord ボット用の設定ファイルのテンプレートがそれぞれ同梱されています。
IRC ボット用のテンプレートは [config/irc.yaml](config/irc.yaml) です。
Discord ボット用のテンプレートファイルは [config/discord.yaml](config/discord.yaml) です。
複数の設定を使う場合は、このファイルをコピーして config/ に設置します。

各設定は**設定 ID** によって識別します。設定 ID とは、config/ 以下に設置した YAML ファイルの、config/ を基準とした相対パスから拡張子を除いたものです。例えば config/rgrb.yaml の場合は `rgrb` となり、config/trpg/detatoko.yaml の場合は `trpg/detatoko` になります。
各設定は**設定 ID** によって識別します。設定 ID とは、config/ 以下に設置した YAML ファイルの、config/ を基準とした相対パスから拡張子を除いたものです。例えば config/irc.yaml の場合は `irc` となり、config/trpg/detatoko.yaml の場合は `trpg/detatoko` になります。

プラグインの設定を別のファイルに書くことも可能です。その場合、親となる設定ファイルの `Include` 節で設定 ID を指定し、子となる設定ファイルを取り込みます。ただし、取り込まれたファイルからさらに他の設定ファイルを取り込むことはできません。具体例は上記の config/rgrb.yaml でご確認ください
プラグインの設定を別のファイルに書くことも可能です。その場合、親となる設定ファイルの `Include` 節で設定 ID を指定し、子となる設定ファイルを取り込みます。ただし、取り込まれたファイルからさらに他の設定ファイルを取り込むことはできません。具体例は上記の設定ファイルのテンプレートでご確認ください

### プラグイン一覧

Expand All @@ -73,6 +76,7 @@ gem install mailcatcher
| 記号 | 意味 |
| ---- | ---- |
| o | 実装済み |
| ! | すべての機能が実装されているわけではない |
| x | 未実装 |
| - | 実装予定なし(チャット環境固有の物) |

Expand Down
6 changes: 3 additions & 3 deletions config/discord.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ DiscordBot:
# 使用するプラグインを列挙する。大文字小文字を区別するので注意
Plugins:
- DiceRoll
- Keyword
- RandomGenerator
- CreBotHelp
- Trpg::Detatoko
- Bcdice
- Keyword
- CreBotHelp

Include:
- dice_roll
- keyword
- random_generator
- keyword
16 changes: 6 additions & 10 deletions config/rgrb.yaml → config/irc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,40 +29,36 @@ IRCBot:
# 空文字列にすると、"Caught <signal>" が設定される
QuitMessage: 'bye'

# Discord ボットの設定
Discord:
# トークン
Token: ''

# クライアント ID
ClientID: ''

# 使用するプラグインを列挙する。大文字小文字を区別するので注意
Plugins:
- DiceRoll
- RandomGenerator
- Trpg::Detatoko
- Bcdice
- Keyword
- OnlineSessionSearch
- CreTwitterCitation
- UrlFetchTitle
- CreBotHelp
- ServerConnectionReport::Charybdis
- Part
- KickBack
- Invite
- Jihou
- Ctcp
- UrlFetchTitle

# 取り込む設定の ID を列挙する
# 設定ファイルは config/ 以下に配置する
# 設定 ID は config/ を基準とした相対パスから拡張子を除いたもの
Include:
- dice_roll
- random_generator
- keyword
- cre_twitter_citation
- url_fetch_title
- server_connection_report/charybdis
- part
- kick_back
- invite
- jihou
- ctcp
- url_fetch_title
2 changes: 1 addition & 1 deletion lib/rgrb/exec/discord_bot.rb
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ def new_bot(config, discord_adapters, plugin_options, log_level, logger)
# @return [Hash]
def parse_options(argv)
default_options = {
config_id: 'rgrb'
config_id: 'discord'
}
default_log_level = {
plugin: :warn,
Expand Down
2 changes: 1 addition & 1 deletion lib/rgrb/exec/irc_bot.rb
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def new_bot(config, irc_adapters, plugin_options, log_level, logger)
# @return [Hash]
def parse_options(argv)
default_options = {
config_id: 'rgrb',
config_id: 'irc',
log_level: :warn
}
options = {}
Expand Down

0 comments on commit 10bb2d6

Please sign in to comment.