Repository navigation
Bouncer setup
Tiarra、ZNC、soju などの bouncer を経由して IRC サーバーにつなぐときに、CayenChat のアイコン(CTCP AVATAR)をほかの利用者に見つけてもらうための設定例です。サーバーの文字コードが UTF-8 でも ISO-2022-JP(IRCnet など)でも、bouncer 側の設定が要ります。
これは設定例です。各 bouncer の動作は保証しません。下の内容は、Debian 13 のパッケージ(
tiarra20100212+r39209-9、znc1.9.1)をローカルの試験用サーバーと IRCnet につないで確かめました(2026-10-19)。
CayenChat は、アイコンを共有していると、実名の先頭に目印を付けます。ほかの CayenChat は、WHO や WHOIS の返事に入る実名の目印を見て、CTCP AVATAR で画像の URL を問い合わせ、あなたはその問い合わせに URL で答えます。
bouncer は、サーバーへの接続(USER)に自分の設定の実名を使います。CayenChat が送った実名はサーバーに届きません。そのため、
- 実名の目印は、bouncer の設定に書く必要があります。
- CTCP AVATAR の返事は、CayenChat がつないでいる間は CayenChat が答えます。CayenChat を閉じている間も答えたいときは、bouncer に答えさせます(Tiarra はモジュール、ZNC は標準の機能)。
付ける目印は、そのネットワークの文字コードで変わります。CayenChat が直接つなぐときに付けるのと同じものです。
| サーバーの文字コード | 目印(実名の先頭に付けるバイト) | 読むクライアント |
|---|---|---|
| UTF-8 など(ISO-2022-JP 以外) | KVIrc の目印 0x03 0x34 0x0F(ETX、4、SI) |
CayenChat と KVIrc |
| ISO-2022-JP | 見えない目印 0x02 0x16 0x16 0x02(太字オン、反転オン、反転オフ、太字オフ) |
CayenChat |
- どちらも生の制御コードです。ほかのクライアントでは書式の指定として扱われ、何も見えません。
\x02のような文字列を書くのではなく、そのバイトそのものを書きます(書き方は次の節)。 -
ネットワークごとに書きます。 すべてのネットワークに共通の実名(Tiarra の
general、ZNC のユーザー設定)には書かないでください。ISO-2022-JP のネットワークに KVIrc の目印(0x0F を含む)が送られると、LimeChat などが不安定になることがあります。 - 生の制御コードを書けない場合は、代わりに文字の目印
\x034\x03(バックスラッシュ、x、0、3、4、バックスラッシュ、x、0、3の 9 文字)を書けます。読むのは CayenChat だけで、ほかのクライアントにはこの 9 文字がそのまま見えます。 - 反映されるのは、bouncer がサーバーにつなぎ直したときです。
設定ファイルは UTF-8 のテキストのまま、目印の部分だけ制御コードのバイトを入れます。
多くのエディタは、「次に押したキーを文字としてそのまま入れる」操作で制御コードを入力できます。
| 入れるバイト | 押すキー | vim(挿入モード) | Emacs | nano |
|---|---|---|---|---|
0x02 |
Ctrl+B |
Ctrl+V Ctrl+B
|
C-q C-b |
Alt+V Ctrl+B
|
0x16 |
Ctrl+V |
Ctrl+V Ctrl+V
|
C-q C-v |
Alt+V Ctrl+V
|
0x03 |
Ctrl+C |
Ctrl+V Ctrl+C
|
C-q C-c |
Alt+V Ctrl+C
|
0x0F |
Ctrl+O |
Ctrl+V Ctrl+O
|
C-q C-o |
Alt+V Ctrl+O
|
KVIrc の目印は Ctrl+C、数字の 4、Ctrl+O の順、見えない目印は Ctrl+B、Ctrl+V、Ctrl+V、Ctrl+B の順です。画面には ^B^V^V^B のように見えます。
エディタで入力しにくいときは、目印を入れたい所に @MARK@ や @KVIRC@ のような仮の文字を書いて保存し、sed でバイトに置き換えます(設定ファイルの名前は自分のものに変えてください。先にコピーを取っておくと安心です)。
cp tiarra.conf tiarra.conf.bak
# @MARK@ を見えない目印、@KVIRC@ を KVIrc の目印に置き換える
sed -i "s/@MARK@/$(printf '\002\026\026\002')/g; s/@KVIRC@/$(printf '\0034\017')/g" tiarra.confたとえば RealName = @MARK@あなたの名前 と書いておくと、RealName = の後ろに見えない目印が入ります。
cat -v で、制御コードが ^B などの形で見えれば、バイトのまま入っています(cat -v では日本語が M- で始まる記号の並びになりますが、ファイルは壊れていません)。
grep -a RealName ~/.znc/configs/znc.conf | cat -v
# RealName = ^B^V^V^B… ← 見えない目印
# RealName = ^C4^O… ← KVIrc の目印\x02 や @MARK@ のような文字がそのまま見えたら、まだバイトになっていません。
Tiarra の設定ファイルでは、値に %CODE{ ... }EDOC% で Perl の式を書くと、その結果が入ります。これを使えば、制御コードをバイトで入力しなくても書けます(上の方法でバイトのまま書いてもかまいません)。
# UTF-8 のサーバー
libera {
server: irc.libera.chat 6667
name: %CODE{"\x034\x0f"}EDOC%あなたの名前
}
# ISO-2022-JP のサーバー
ircnet {
server: irc.ircnet.ne.jp 6667
name: %CODE{"\x02\x16\x16\x02"}EDOC%あなたの名前
}
試験では、server-out-encoding: utf8 で USER の実名が 03 34 0F に続く UTF-8 の名前として、jis で 02 16 16 02 に続く ISO-2022-JP の名前として送られました。
Tiarra には AVATAR に答える機能がないので、次のモジュールを足します。CayenChat を閉じているときや、ほかのクライアントでつないでいるときも、Tiarra が画像の URL を答えます。
- 同じ人には 10 秒に 1 回、全体では 10 秒に 5 回まで答えます(CayenChat 自身の上限と同じ)。
- 答えた問い合わせはクライアントに渡しません(CayenChat も答えて返事が二重になるのを防ぐため)。上限を超えて答えなかった問い合わせはクライアントに渡すので、CayenChat がつないでいれば CayenChat が答えます。
次の内容を CTCP/Avatar.pm として保存します。置き場所は、Tiarra の入れ方によって変わります。
-
ソースから入れた Tiarra:Tiarra のディレクトリの
module/CTCP/Avatar.pm。 -
Debian の
tiarraパッケージ:パッケージのファイル(/usr/share/tiarra/module/)には足さず、自分のディレクトリに置きます。-
~/.tiarra/module/CTCP/Avatar.pmに保存します(tiarra.confも~/.tiarra/に置きます)。 - Perl がそこを探すように、環境変数
PERL5LIBを付けて起動します。PERL5LIB=$HOME/.tiarra/module tiarra/usr/bin/tiarraは~/.tiarra(TIARRADIR)に移って/usr/share/tiarra/tiarraを動かすだけのスクリプトなので、環境変数はそのまま引き継がれます。systemd などから起動している場合は、そちらの設定にPERL5LIBを足してください。付け忘れるとモジュールが読み込まれず、Tiarra のログにエラーが出ます。
-
# -----------------------------------------------------------------------------
# CTCP AVATAR に、設定した画像の URL で答える。
# -----------------------------------------------------------------------------
package CTCP::Avatar;
use strict;
use warnings;
use base qw(Module);
use CTCP;
use Multicast;
sub new {
my $class = shift;
my $this = $class->SUPER::new(@_);
$this->{asked} = {}; # 問い合わせた人ごとの、最後に答えた時刻
$this->{recent} = []; # 全体で最近答えた時刻
$this;
}
sub message_arrived {
my ($this, $msg, $sender) = @_;
if ($sender->isa('IrcIO::Server') &&
$msg->command eq 'PRIVMSG' &&
defined $msg->nick) {
my $ctcp = CTCP::extract($msg);
my $url = $this->config->url;
if (defined $ctcp && $ctcp =~ /^AVATAR\s*$/i &&
defined $url && $url ne '') {
my $nick = scalar Multicast::detach($msg->nick);
if ($this->may_answer($sender->network_name, $nick)) {
$sender->send_message(CTCP::make("AVATAR $url", $nick));
# 答えた問い合わせはクライアントに渡さない(返事が二重になるのを防ぐ)。
return undef;
}
# 上限を超えたときは答えず、クライアントに渡す(つないでいれば、
# クライアントが代わりに答えられる)。
}
}
$msg;
}
# 同じ人には per-user-interval 秒に 1 回、全体では window 秒に max-replies 回まで。
sub may_answer {
my ($this, $network, $nick) = @_;
my $now = time;
my $window = $this->config->window || 10;
my $max = $this->config->get('max-replies') || 5;
my $interval = $this->config->get('per-user-interval') || 10;
my $key = $network . "\0" . lc $nick;
@{$this->{recent}} = grep { $now - $_ < $window } @{$this->{recent}};
for my $asked (keys %{$this->{asked}}) {
delete $this->{asked}{$asked} if $now - $this->{asked}{$asked} >= $interval;
}
return 0 if exists $this->{asked}{$key};
return 0 if @{$this->{recent}} >= $max;
$this->{asked}{$key} = $now;
push @{$this->{recent}}, $now;
1;
}
1;
=pod
info: CTCP AVATAR に、設定した画像の URL で答える。
default: off
# 答える画像の URL。
url: https://example.com/avatar.png
# 同じ人に答える間隔(秒)。省略時は 10。
per-user-interval: 10
# 全体で window 秒の間に答える最大の回数。省略時は 10 秒に 5 回。
window: 10
max-replies: 5
=cut設定ファイルに次を足します。
+ CTCP::Avatar {
url: https://example.com/avatar.png
}
-
urlには、CayenChat の「アイコンを共有」に設定しているのと同じ、https://の画像の URL を書きます。 - 試験では、3 人(alice、bob、carol)からの問い合わせにそれぞれ答え、続けて来た alice の 2 回目には答えずにクライアントに渡しました。IRCnet でも、問い合わせにすぐ URL を返しました。
ネットワークごとの RealName に目印を書きます。ZNC には Tiarra の %CODE に当たる仕組みがないので、制御コードはバイトのまま書きます(上の「制御コードを設定ファイルにバイトのまま書く方法」)。
<User あなた>
RealName = あなたの名前
<Network libera>
RealName = ^C4^Oあなたの名前
</Network>
<Network ircnet>
Encoding = ISO-2022-JP
RealName = ^B^V^V^Bあなたの名前
</Network>
</User>
(^C などは cat -v での見え方です。実際には 1 バイトの制御コードです。)
-
znc.confは ZNC を止めてから編集します。 ZNC は動いている間に設定ファイルを書き直すことがあり、そのとき手で直した内容が消えます。試験では、ZNC が書き直したあともRealNameの制御コードはバイトのまま残りました。 - 動いている ZNC を止めずに変えるなら、制御コードを打ち込めるクライアントから
/msg *controlpanel SetNetwork RealName <ユーザー> <ネットワーク> <実名>を送ります(controlpanelモジュールが要ります)。 - 試験では、
Encoding = ISO-2022-JPのネットワークで、USERの実名が02 16 16 02に続く ISO-2022-JP の名前として送られました。
ZNC は、CTCP の返事を設定する機能を標準で持っています。モジュールは要りません。ユーザー設定に次を足します(webadmin の「CTCP Replies」に AVATAR https://… と書いても同じです)。
<User あなた>
CTCPReply = AVATAR https://example.com/avatar.png
</User>
動いている ZNC なら、/msg *controlpanel AddCTCP <ユーザー> AVATAR https://example.com/avatar.png でも設定できます。
- クライアントがつないでいるかどうかに関係なく、ZNC が
NOTICE <相手> :\x01AVATAR <URL>\x01を返します。答えた問い合わせはクライアントに渡さないので、返事は二重になりません。 - この設定はユーザー単位なので、すべてのネットワークで同じ URL を返します。
- 連続した問い合わせへの返事は、ZNC 全体の CTCP の上限(5 秒に 5 回)の範囲内です。
- 試験では、
:alice!a@h PRIVMSG znctest :\x01AVATAR\x01にNOTICE alice :\x01AVATAR https://example.com/avatar.png\x01を返しました。
soju も、クライアントが送った実名をサーバーに渡しません。上の表の目印を、ネットワークごとの実名に設定します。
-
network update <ネットワーク名> -realname <実名>(soju のサービスに送る)か、そのネットワークにつないだ状態でクライアントからSETNAMEを送ります。どちらも、制御コードを打ち込めるクライアントからなら目印を含められます。打ち込めない場合は、文字の目印\x034\x03を使ってください。 - サーバーが
setnameに対応していない IRCnet では、soju がサーバーとの接続を一度つなぎ直します。 - soju には AVATAR に答える機能がないので、CayenChat の「アイコンを共有」をオンにします。CayenChat がつないでいる間だけ答えます。
- サーバーの設定の IRCv3 タブで、CTCP AVATAR の交換をオンにします。ほかの人のアイコンを受け取るのに必要です。
- 同じサーバーの設定で、ユーザーのアイコンを表示をオンにします(既定はオフ)。
- bouncer が AVATAR に答えるなら、CayenChat の「アイコンを共有」はオンでもオフでもかまいません。答えないなら、オンにします。
-
bouncer 経由の CayenChat から見たときの IRCnet:IRCnet の WHO の返事にはサーバー ID が入り、CayenChat は登録時の
042を見てそれを読み飛ばします。Tiarra も ZNC も042をクライアントに渡さないため、bouncer 経由でつないだ CayenChat は、発言をきっかけにした問い合わせで目印を見落とします(#508 で修正予定)。WHOIS の画面の「アバターを取得」は、この影響を受けません。 - CayenChat は、相手の実名を一度見て「目印なし」と判断すると、その接続の間は問い合わせません。目印を付ける前のあなたを見ていた相手には、再接続するか、WHOIS の画面の「アバターを取得」を押してもらってください。
- 見えない目印を読めるのは、2026-10-19 以降のベータ版の CayenChat です。