NuVotifierの使い方と設定

このページではNuVotifierの使い方、導入方法、コマンド、パーミッション、設定などを解説します。

NuVotifierとは

NuVotifierはVotifierからフォークされたプラグインです。

このプラグインはサーバーリストサイトなどで使われているVotifierプロトコルを実装します。

いわゆる「投票」機能は基本的にこのプロトコルを使用しているため、投票でのアイテム配布を実装する場合には必須です。

使い方

NuVotifierは基本的に単体では効果がありません。

投票された際にアイテムやお金を配布するにはリスナープラグインが必要です。

導入方法

NuVotifierそのものには前提プラグインなどは必要ありませんが、先の通り効果を発揮するにはリスナープラグインが別途必要です。

GitHubなどからプラグインをダウンロードして設定を行ってください。

また、NuVotifierは投票を受け付けるためにTCP 8192ポートを使用します。ポート開放を行ってください。

ポート開放の説明は省略します。

コマンド

NuVotifierには/nvreloadコマンドしかありません。

これは設定ファイルをリロードするコマンドで、パーミッションはnuvotifier.consoleです。

設定

設定ファイルはデフォルトのままで問題ありません。

投票サイトなどで「公開鍵」や「public key」と呼ばれる物を要求されると思いますが、これはplugins/Votifier/rsa/public.keyの内容をペーストすればOKです。

間違えてprivate.keyをペーストしないように注意しましょう。

config.yml

基本的にデフォルトのままで問題ありません。

# バインドアドレス、基本的に0.0.0.0のままで問題ない。
host: 0.0.0.0

# ポート番号
port: 8192

# デバッグモードを使用するか
debug: false

# このオプションをtrueにするとv1プロトコルが無効になる。
# v1プロトコルは安全ではないが、現状としてv1プロトコルしかサポートされていない場合がほとんど。
disable-v1-protocol: false

# トークン、サービス別に設定可能
tokens:
  # デフォルトのトークン
  default: "ランダムで生産される英数字"

# 他のサーバーに投票を転送する設定
forwarding:
  # 転送方法を設定
  # - none - 転送しない
  # - pluginMessaging - プラグインメッセージングを使用
  method: none
  pluginMessaging:
    channel: nuvotifier:votes