Revolt Chat Exporter (User Token Edition)

特定のチャンネルのチャット履歴をMarkdownファイルにエクスポートするためのシンプルなRevoltツールです。

機能

• exporter.js: 指定した任意のチャンネルからチャット履歴をエクスポートします。
• note_exporter.js: あなたの "Saved Notes"（保存済みノート）専用のチャット履歴をエクスポートします。
• セルフホスト環境向けにAPIエンドポイントをカスタマイズ可能です。
• 出力形式はMarkdownです。

前提条件

• Node.js (v16以上)
• npm

インストール

1. このリポジトリをクローンします:

   git clone https://github.com/puyokura/revolt_tool_1.git
   cd revolt_tool_1

2. 依存関係をインストールします:

   npm install

使い方 (Usage)

このツールは、コマンドライン引数またはconfig.jsonファイルを使用して設定できます。コマンドライン引数が指定された場合、config.jsonの設定よりも優先されます。

オススメ: コマンドライン引数での利用

revce コマンドに続けて、オプションを指定して実行します。

revce --token "あなたのユーザートークン" --channel "エクスポートしたいチャンネルID"

利用可能なオプション

| Option | Alias | Description | Required | | :--- | :--- | :--- | :--- | | --token | -t | あなたのRevoltユーザートークン。 | はい | | --channel | -c | エクスポートしたいチャンネルのID。 | はい | | --api | -a | Revolt APIのエンドポイントURL。 | いいえ | | --help | -h | ヘルプメッセージを表示します。 | いいえ |

従来の方法: config.json での設定

従来通り、config.jsonファイルで設定することも可能です。

スクリプトを実行する前に、ルートディレクトリに config.json ファイルを作成し、あなたのRevoltユーザートークンを設定する必要があります。

セキュリティのため、config.json は .gitignore に含まれており、リポジトリにはアップロードされません。

config.json の作成

実行したいスクリプトに応じて、以下の内容で config.json を作成してください。

exporter.js 用 (任意のチャンネル)

特定のチャンネルをエクスポートする場合は、チャンネルIDも指定します。

{
  "userToken": "ここにあなたのユーザートークンを貼り付け",
  "targetChannelId": "エクスポートしたいチャンネルのID",
  "apiURL": "https://api.revolt.chat"
}

• apiURL (任意): あなたのRevoltインスタンスのAPIエンドポイント。デフォルトは https://api.revolt.chat です。

note_exporter.js 用 ("Saved Notes")

"Saved Notes" をエクスポートする場合は、userToken のみで動作します。

{
  "userToken": "ここにあなたのユーザートークンを貼り付け",
  "apiURL": "https://api.revolt.chat"
}

スクリプトの実行

config.json を使用する場合、以下のコマンドで実行します。

# exporter.js (任意のチャンネル)
npm start
# または
node exporter.js

# note_exporter.js ("Saved Notes")
node note_exporter.js

ツールは指定された場所からすべてのメッセージを取得し、exports ディレクトリにMarkdownファイルとして保存します。