Greasy Fork が読み込むユーザースクリプトのメタキーの一覧です。以下の一覧にないキーをスクリプトに含めることも可能で、そのキーはインストールされたスクリプト中にも含まれることになりますが、Greasy Fork の UI (表示) には影響しません。
- §
@name - 見出しやリンクとして使用されるスクリプトの名前。必須。
- §
@name:XX-YY - 特定の言語におけるスクリプトの名前で、XX は ISO 639-1の2文字コード、任意指定の YY は ISO 3166の国名コード。ユーザーが対応する言語で閲覧しているときに、
@nameを上書きします。 - §
@description - スクリプトがなにをするのかについての説明。スクリプト名の下にテキストとして表示。必須。
- §
@description:XX-YY - 特定の言語におけるスクリプトの説明で、XX はISO 639-1の2文字コード、任意指定の YY は ISO 3166の国名コード。ユーザーが対応する言語で閲覧しているときに、
@descriptionを上書きします。 - §
@namespace - ユーザースクリプト管理ツールは、
@namespaceと@nameの組み合わせで、スクリプトがすでにインストールされているか否かを判断します。Greasy Fork ではこのキーを必須としており、スクリプト更新時に変更された場合は警告を表示します。 - §
@version - Mozilla のバージョン規則によるスクリプトのバージョンの指定です。バージョンはスクリプトの情報ページに表示されいます。Greasy Fork はこの項目を必須とし、スクリプトのコードが変更された際に、値が減少、または増加していない場合に警告します。
- §
@include,@exclude,@match - スクリプトを実行するページを指定します。この一覧は処理されてスクリプトの情報ページに表示され、またスクリプトの分類に使われます。各スクリプトには 1 回以上の
@matchか@includeを含めてください。そのフォーマットについては ここをお読みください。 - §
@require - 外部の JavaScript をスクリプトに含めます。外部のスクリプトをコードに含める際の規則をご確認ください。サブリソースの整合性ハッシュ（こことここの情報を参照）を使っていて、ハッシュが使用するURLのハッシュと一致しない際に、Greasy Forkは警告します。
- §
@resource - スクリプトに外部のリソース（JavaScript、CSS、画像など）を含めます。外部のスクリプトをコードに含める際の規則をご確認ください。サブリソースの整合性ハッシュ（こことここの情報を参照）を使っていて、ハッシュが使用するURLのハッシュと一致しない際に、Greasy Forkは警告します。
- §
@updateURL,@installURL,@downloadURL - ユーザースクリプト管理ツールが更新を取得する方法の記述。Greasy Fork はこれらのキーを取り除き、Greasy Fork からインストールされたすべてのスクリプトが Greasy Fork から更新されるようにします。
- §
@license - Greasy Fork にスクリプトを投稿することで、あなたは他者にそれをインストールし使用することを許可します。付属させるライセンスは、あなたのスクリプトを、修正したり再配布できるかの許可を説明するものです。ライセンスはスクリプトの情報ページに表示されます。
@licenseは以下のように使用:- ライセンスの名称 (例:
@licence GPL3)。the SPDX にあるライセンス一覧 にある「完全な名称」Full name または「識別子」Identifier の使用を推奨します。 - 使用を許可する条件 (例:
@license You can modify as long as you credit me: 私のクレジットを表記すれば修正を許可します)。既存のライセンスの使用を推奨します。 - 著作権の宣言 (例:
@license Copyright MyName)。いずれかのライセンスの使用を望まないということです。 - まったくない場合、著作権の宣言と同じ意味になりますが、ユーザーに対しては不明確です。
- ライセンスの名称 (例:
- §
@supportURL - ユーザーがスクリプトのサポートを受けることができるページの URL (例: バグトラッカー、フォーラム、電子メールアドレス)。サポート URL はスクリプトのフィードバックページに表示されます。
- §
@contributionURL - ユーザーがスクリプト作者に寄付することができるページの URL。貢献 URL はスクリプトのフィードバックページに表示されます。http、https、bitcoin スキームの URL が指定可能です。PayPal の寄付ページにリンクするには、 https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=your.email.here@example.com&item_name=Greasy+Fork+donationのような形式の URL を使用し、サンプルのメールアドレスを自分のものに置き換えます。
- §
@contributionAmount - 提示する寄付金額。
@contributionURLと共に使用します。 - §
@compatible - スクリプトがどのブラウザと互換性があるか。互換性はスクリプトの情報ページに表示されます。
@compatible firefox ポップアップブロックの無効化が必須のような形式で、互換性に関するコメントを含めることもできます。認識されるブラウザ:firefox,chrome,opera,safari,edge - §
@incompatible - スクリプトがどのブラウザと互換性がないか。互換性はスクリプトの情報ページに表示されます。
@incompatible firefox Firefox 23 以降で動作しないのような形式で、互換性に関するコメントを含めることもできます。認識されるブラウザ:firefox,chrome,opera,safari,edge - §
@antifeature - ユーザーではなく作者の利益を目的としたスクリプトの機能を開示します。このキーの形式は、
@antifeature type descriptionで、type : 種類は必須、description : 説明は任意です。こちらの情報は、 type の種類について Greasy Fork で指定可能な一覧です。 - §
@antifeature:XX-YY @antifeatureの説明を特定の言語で記述します。XX は ISO 639-1 の2文字コード で、YY として ISO 3166 の国名コード を追加することもできます。ユーザーの使用言語に一致したら@antifeatureの内容を上書きします。