ai/README.md

66 lines
4.3 KiB
Markdown
Raw Normal View History

2019-01-15 10:16:17 +00:00
<h1><p align="center"><img src="./ai.svg" alt="藍" height="200"></p></h1>
<p align="center">An Ai for Misskey. <a href="./torisetu.md">About Ai</a></p>
## これなに
2019-01-15 10:17:46 +00:00
Misskey用の日本語Botです。
2018-09-02 10:35:10 +00:00
2018-08-18 19:36:03 +00:00
## インストール
2018-09-23 14:46:57 +00:00
> Node.js と npm と MeCab (オプション) がインストールされている必要があります。
2018-08-28 21:35:05 +00:00
まず適当なディレクトリに `git clone` します。
次にそのディレクトリに `config.json` を作成します。中身は次のようにします:
2018-09-23 22:44:06 +00:00
``` json
2018-08-18 19:36:03 +00:00
{
2018-09-23 14:46:57 +00:00
"host": "https:// + あなたのインスタンスのURL (末尾の / は除く)",
2020-08-23 02:31:35 +00:00
"i": "藍として動かしたいアカウントのアクセストークン",
2020-09-12 10:46:33 +00:00
"master": "管理者のユーザー名(オプション)",
"notingEnabled": "ランダムにノートを投稿する機能を無効にする場合は false を入れる",
2018-09-23 14:46:57 +00:00
"keywordEnabled": "キーワードを覚える機能 (MeCab が必要) を有効にする場合は true を入れる (無効にする場合は false)",
2019-06-15 14:49:11 +00:00
"chartEnabled": "チャート機能を無効化する場合は false を入れてください",
2018-09-23 14:46:57 +00:00
"reversiEnabled": "藍とリバーシで対局できる機能を有効にする場合は true を入れる (無効にする場合は false)",
"serverMonitoring": "サーバー監視の機能を有効にする場合は true を入れる (無効にする場合は false)",
"checkEmojisEnabled": "カスタム絵文字チェック機能を有効にする場合は true を入れる (無効にする場合は false)",
"checkEmojisAtOnce": "カスタム絵文字チェック機能で投稿をまとめる場合は true を入れる (まとめない場合は false)",
"mecab": "MeCab のインストールパス (ソースからインストールした場合、大体は /usr/local/bin/mecab)",
"mecabDic": "MeCab の辞書ファイルパス (オプション)",
2021-12-07 02:48:48 +00:00
"memoryDir": "memory.jsonの保存先オプション、デフォルトは'.'(レポジトリのルートです))"
2018-08-18 19:36:03 +00:00
}
```
2019-02-01 16:53:06 +00:00
`npm install` して `npm run build` して `npm start` すれば起動できます
2018-08-29 08:44:51 +00:00
## Dockerで動かす
まず適当なディレクトリに `git clone` します。
次にそのディレクトリに `config.json` を作成します。中身は次のようにします:
2021-12-07 02:48:48 +00:00
MeCabの設定、memoryDirについては触らないでください
``` json
{
"host": "https:// + あなたのインスタンスのURL (末尾の / は除く)",
"i": "藍として動かしたいアカウントのアクセストークン",
"master": "管理者のユーザー名(オプション)",
"notingEnabled": "ランダムにノートを投稿する機能を無効にする場合は false を入れる",
"keywordEnabled": "キーワードを覚える機能 (MeCab が必要) を有効にする場合は true を入れる (無効にする場合は false)",
"chartEnabled": "チャート機能を無効化する場合は false を入れてください",
"reversiEnabled": "藍とリバーシで対局できる機能を有効にする場合は true を入れる (無効にする場合は false)",
"serverMonitoring": "サーバー監視の機能を有効にする場合は true を入れる (無効にする場合は false)",
"checkEmojisEnabled": "カスタム絵文字チェック機能を有効にする場合は true を入れる (無効にする場合は false)",
"checkEmojisAtOnce": "カスタム絵文字チェック機能で投稿をまとめる場合は true を入れる (まとめない場合は false)",
"mecab": "/usr/bin/mecab",
"mecabDic": "/usr/lib/x86_64-linux-gnu/mecab/dic/mecab-ipadic-neologd/",
2021-12-07 02:48:48 +00:00
"memoryDir": "data"
}
```
`docker-compose build` して `docker-compose up` すれば起動できます。
`docker-compose.yml``enable_mecab``0` にすると、MeCabをインストールしないようにもできます。メモリが少ない環境など
2019-05-12 17:09:56 +00:00
## フォント
一部の機能にはフォントが必要です。藍にはフォントは同梱されていないので、ご自身でフォントをインストールディレクトリに`font.ttf`という名前で設置してください。
2019-01-24 08:57:07 +00:00
## 記憶
藍は記憶の保持にインメモリデータベースを使用しており、藍のインストールディレクトリに `memory.json` という名前で永続化されます。
2018-08-29 08:44:51 +00:00
## ライセンス
MIT
2019-01-20 10:30:23 +00:00
## Awards
<img src="./WorksOnMyMachine.png" alt="Works on my machine" height="120">