Skip to content

adzukimame/ai

 
 

Repository files navigation

藍

An Ai for Misskey. About Ai

これなに

Misskey用の日本語Botです。

インストール

Node.js と npm と MeCab (オプション) がインストールされている必要があります。

まず適当なディレクトリに git clone します。 次にそのディレクトリに config.json を作成します。中身は次のようにします:

{
	"host": "https:// + あなたのインスタンスのURL (末尾の / は除く)",
	"i": "藍として動かしたいアカウントのアクセストークン",
	"master": "管理者のユーザー名(オプション)",
	"restrictCommunication": "制限モードを有効にする場合は true を入れる (無効にする場合は false)",
	"notingEnabled": "ランダムにノートを投稿する機能を無効にする場合は false を入れる",
	"keywordEnabled": "キーワードを覚える機能 (MeCab が必要) を有効にする場合は true を入れる (無効にする場合は false)",
	"chartEnabled": "チャート機能を無効化する場合は false を入れてください",
	"reversiEnabled": "藍とリバーシで対局できる機能を有効にする場合は true を入れる (無効にする場合は false)",
	"serverMonitoring": "サーバー監視の機能を有効にする場合は true を入れる (無効にする場合は false)",
	"checkEmojisEnabled": "カスタム絵文字チェック機能を有効にする場合は true を入れる (無効にする場合は false)",
	"checkEmojisAtOnce": "カスタム絵文字チェック機能で投稿をまとめる場合は true を入れる (まとめない場合は false)",
	"mazeDisabled": "迷路の生成を無効にする場合は true を入れてください",
	"pollDisabled": "アンケートを無効にする場合は true を入れてください",
	"mecab": "MeCab のインストールパス (ソースからインストールした場合、大体は /usr/local/bin/mecab)",
	"mecabDic": "MeCab の辞書ファイルパス (オプション)",
	"memoryDir": "memory.jsonの保存先(オプション、デフォルトは'.'(レポジトリのルートです))"
}

npm install して npm run build して npm start すれば起動できます

Dockerで動かす

まず適当なディレクトリに git clone します。 次にそのディレクトリに config.json を作成します。中身は次のようにします: (MeCabの設定、memoryDirについては触らないでください)

{
	"host": "https:// + あなたのインスタンスのURL (末尾の / は除く)",
	"i": "藍として動かしたいアカウントのアクセストークン",
	"master": "管理者のユーザー名(オプション)",
	"restrictCommunication": "制限モードを有効にする場合は true を入れる (無効にする場合は false)",
	"notingEnabled": "ランダムにノートを投稿する機能を無効にする場合は false を入れる",
	"keywordEnabled": "キーワードを覚える機能 (MeCab が必要) を有効にする場合は true を入れる (無効にする場合は false)",
	"chartEnabled": "チャート機能を無効化する場合は false を入れてください",
	"reversiEnabled": "藍とリバーシで対局できる機能を有効にする場合は true を入れる (無効にする場合は false)",
	"serverMonitoring": "サーバー監視の機能を有効にする場合は true を入れる (無効にする場合は false)",
	"checkEmojisEnabled": "カスタム絵文字チェック機能を有効にする場合は true を入れる (無効にする場合は false)",
	"checkEmojisAtOnce": "カスタム絵文字チェック機能で投稿をまとめる場合は true を入れる (まとめない場合は false)",
	"mazeDisabled": "迷路の生成を無効にする場合は true を入れてください",
	"pollDisabled": "アンケートを無効にする場合は true を入れてください",
	"mecab": "/usr/bin/mecab",
	"mecabDic": "/var/lib/mecab/dic/ipadic-utf8/",
	"memoryDir": "data"
}

docker-compose build して docker-compose up すれば起動できます。 docker-compose.ymlenable_mecab0 にすると、MeCabをインストールしないようにもできます。(メモリが少ない環境など)

フォント

一部の機能にはフォントが必要です。藍にはフォントは同梱されていないので、ご自身でフォントをインストールディレクトリにfont.ttfという名前で設置してください。

記憶

藍は記憶の保持にインメモリデータベースを使用しており、藍のインストールディレクトリに memory.json という名前で永続化されます。

オリジナルの藍との相違点

制限モード

おひとりさまサーバーで、藍が多数のサーバーの多数のリモートユーザーをフォローする(させられる)ことを防ぎたい場合などに、制限モードを有効にできます。

制限モードを有効にすると、フォロワーが0人のリモートユーザーからのメンション・リプライ・引用リノートに一切反応しなくなります。

また、

  • 詳細を取得したことのないリモートユーザー(藍がusers/showAPIエンドポイントに問い合わせを行ったことのないユーザー)
  • 最後に詳細を取得したときに、フォロワーが0人だったリモートユーザー

に誕生日やバレンタインのメッセージを送信しなくなります。

制限モードが有効で、アカウントの設定がフォロー承認制になっている場合、フォロワーが0人のリモートユーザーからのフォローリクエストは自動で拒否し、それ以外のユーザーからのフォローリクエストは自動で承認します。

キーワードを覚える機能

より多くのキーワードを覚えるために、仮名と英語の変換辞書を追加で利用することができます。

Google日本語入力の和英辞書作成プロジェクト より このディレクトリ のテキストファイルを連結し、google-ime-user-dictionary-ja-en.txtという名前で藍のインストールディレクトリに配置してください。
(※google-ime-jp-カタカナ英語辞書01-あ~お.txtファイルは連結から除外してください。)

ライセンス

MIT

Awards

Works on my machine

About

💕 A bot for Misskey

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 98.9%
  • Other 1.1%