niconicomments for onecomme

niconicommentsを使ってコメントを表示する配信者向けツールです

注意事項

なにか損害が発生しても一切責任を負いません
特許を侵害しないように作成していますが、心配な方は使用しないことをおすすめします
なんのこっちゃという方は以下のリンクを御覧ください
https://github.com/xpadev-net/niconicomments/blob/develop/ABOUT_PATENT.md
基本的にニコニコ動画との互換性を重視して作成しているため現状設定項目はありません
要望などあれば検討しますので作者までご連絡ください

特徴

ニコニコ動画との互換性が高いです
※ニコニコ生放送との互換性は検証していません

使い方

リリースから最新版のzip(niconicomments_for_onecomme-バージョン.zip)をダウンロード
zipを解凍
わんコメ右上の三点リーダーからフォルダを開く
開いたフォルダーに解凍したzipフォルダーを放り込む
テンプレをOBSに追加

コンフィグ

フォルダー内にあるconfig.jsonを変更してください

使用できるコマンドについて

使用できるコマンドはすべてニコニコ動画の仕様に準拠しています
一部独自実装のコマンドについてはniconicommentsのドキュメントを参照してください

commands

指定したフィールドが特定の値の場合にコマンドを適用することが出来ます
フィールドの仕様はわんコメ公式の技術ドキュメント Commentの構造を参照してください
ネストしているフィールドについては item.name などフィールド名を . でつなげることで参照できます
データは CommonData 直下から読み込まれるため、 BaseComment や各配信サービスのデータを取得したい場合は先頭に data. を付ける必要があります
commands内に各条件を配列として書き込んでください

データ構造は以下のとおりです

type condition = {
  "object": "<string>", //フィールド名
  "operator"?: "equal"|"moreThan"|"lessThan", //無指定か"equal"(等しい)、"moreThan"(より多い)、"lessThan"(未満)のいずれかを指定することができます。指定しなかった場合はequalとして処理されます
  "value": "<any>" //比較対象の値
}
type commands = {
  "condition": condition | condition[];//条件
  "content": "<string>" //条件に合致する場合に適用されるコマンド
}

サンプル

{
  "condition": { //適用する条件
    "object": "data.isFirstTime", //コメントのどのフィールドを参照するかを指定してください
    "value": true //参照したフィールドが指定された値の場合コマンドが適用されます
  },
  "content": "big red" //適用したいコマンド(スペース区切り)
}

{
  "condition": [//適用する条件
    { 
      "object": "data.price", //スパチャの額が
      "operator": "moreThan", //より多い
      "value": 1000 //1000
    },
    {
      "object": "data.unit", //通貨の単位が
      "operator": "equal",//等しい
      "value": "¥" //円
    }
  ],
  "content": "big red" //適用したいコマンド(スペース区切り)
}

defaultCommand

すべてのコメントにデフォルトで適用されるコマンドを指定します

replace

コメントの内容に対する置換を設定します
正規表現で記述することができ、フラグはg(すべて)、u(Unicode)、i(大文字小文字を区別しない)が設定されます
置換の処理順は
ユーザー定義 → htmlタグ削除 → htmlSpecialCharsのデコード
となります

{
  "<div>(.*?)</div>": "[$1]" //divの中に含まれる内容を[]で囲って表示する
}

例: 接続開始後最初のコメントの場合、red bigを適用する

{
  "commands": [
    {
      "condition": {
        "object": "data.isFirstTime",
        "value": true
      },
      "content": "big red"
    }
  ],
  "defaultCommand": ""
}

スペシャルサンクス

Aka Diffusion さんのフォークからHTMLの対応及び複数の条件設定の実装を取り込ませていただきました

xpadev-net/niconicomments-for-onecomme