plugin.xmlの詳細解説

各項目

plugin_xml_version

XMLの形式のバージョンです。
今のところは2で固定です。

general

name

プラグインの名前です。

Danger

フォルダ名と同一である必要があります。

/と:は使用禁止です。
英大文字、英小文字、数字のみを使うことを推奨します。

version

プラグインのバージョンです。
現在は何にも使用されていません。

Warning

整数である必要があります。

Todo

将来的にはこの数値を使ってアップデート処理などをできるようにするかもしれません。

description

プラグインの説明です。
PCCClientで表示されるためだけにあります。
そのプラグインの持つ機能や使用方法などについて説明してください。

Hint

行頭と行末のスペースやタブなどは削除されて表示されます。

plugin_author

プラグインの作成者を書きます。
本名でもハンドルネームでも構いませんが、pc番号(pc21509など)を含めることを強くおすすめします。(将来的には義務になる可能性があります)

plugin_licence

プラグインのライセンスを指定します。

Hint

特に希望がなければ、PD(Public Domain)やMITなどをおすすめします。

dependency

dependentタグで依存関係を列挙します。
いくつでも指定できます。

dependent

内容にパッケージ識別子を指定します。

Hint

(内部)プラグインの指定にリポジトリを明示するのは非推奨です。
unofficialからofficial入りした場合などに見つからなくなってしまうためと、personalでオリジナルの改変を加えて使うことができるようにするためです。

beforeという属性を指定できます。
trueの場合はこのプラグインのactionが実行される前に、その依存関係のインストール完了を待機します。
指定しなかった場合falseと扱われます。

Hint

このプラグインの動作に必要だがインストールには不要な場合はfalse、インストールに必要な場合はtrueを指定してください。

例:

• <dependent before="true">7zip</dependent>: 内部リポジトリの中で最初に見つかった7zipというパッケージをこのプラグインのインストール処理前にインストールします。
• <dependent before="true">official:7zip</dependent>: officialというリポジトリの7zipというパッケージをこのプラグインと並列にインストールします。(非推奨の記法です)
• <dependent>Chocolatey:AndroidStudio</dependent>: ChocolateyというリポジトリのAndroidStudioというパッケージをこのプラグインと並列にインストールします。

actions

プラグインのactionを指定します。
別ページを参照してください

buttons

PCCClientに表示するボタンを設定します。
タグ名は内部でボタンIDとして使われるので重複しないようにしてください。

name

ボタンに表示される名前です。

action

そのボタンが押された際に実行されるactionの名前です。

form

Todo

まだ使えません

これを指定した場合、ボタンを押すとフォームが表示され、入力を完了してからactionが実行されるようになります。
これを指定しない、または空の場合はボタンを押すと即座にactionが実行されます。

フォームの回答は${plugin_tempdir}\form.jsonに保存されます。

詳細は別ページを参照してください。

config

これを指定した場合、PCCClientに設定画面が追加されます。
これを指定しない、または空の場合、設定機能は無効になります。

設定内容は${plugin_tempdir}\plugin_config.jsonに保存されます。

記法の詳細は別ページを参照してください。