Skip to content

Latest commit

 

History

History
96 lines (77 loc) · 6.23 KB

SPECIFICATION.md

File metadata and controls

96 lines (77 loc) · 6.23 KB

apm-data v2 仕様書

説明にはXPathを使用しています。

  • 太字の要素: 必須要素
  • 斜体の要素: 任意要素

リストの更新日時ファイル

  • /mod/@version: データバージョン(固定値: 2)
  • /mod/core: core.xmlの更新日時
  • /mod/packages_list: packages_list.xmlの更新日時
  • /mod/convert: convert.jsonの更新日時
  • /mod/packages_list: scripts.jsonの更新日時

AviUtlと拡張編集Pluginのデータファイル

  • /core/@version: データバージョン(固定値: 2)
  • /core/{program}/latestVersion: プログラムの最新バージョン
  • /core/{program}/files/file: プログラムで使用されるファイルのファイル名
    • /core/{program}/files/file/@optional: インストール時に必要ないかどうか(デフォルト: false)
    • /core/{program}/files/file/@installOnly: アンインストール不可のファイルかどうか(デフォルト: false)
    • /core/{program}/files/file/@directory: ディレクトリかどうか(デフォルト: false)
    • /core/{program}/files/file/@archivePath: ファイルのアーカイブ内相対パス(デフォルト: null)
    • /core/{program}/files/file/@obsolete: 最新バージョンに存在しないかどうか(デフォルト: false)
  • /core/{program}/releases/release: プログラムのリリース
    • /core/{program}/releases/release/@version: そのリリースのバージョン
    • /core/{program}/releases/release/url: リリースされたアーカイブのURL
    • /core/{program}/releases/release/files/file: そのバージョンにのみ含まれるファイル(/core/{program}/files/fileを参照)
    • /core/{program}/releases/release/archiveIntegrity: アーカイブのハッシュ
      • /core/{program}/releases/release/integrities/integrity: ファイルのハッシュ
        • /core/{program}/releases/release/integrities/integrity/@target: 対象のファイル名

プラグインとスクリプトのデータファイル

  • /packages/@version: データバージョン(固定値: 2)
  • /packages/package/id: パッケージのID(重複しない半角英数字。パッケージを表すファイル名を使用し、それが無ければ、アーカイブのファイル名を使用します。一語しかないなど、重複の可能性があれば、開発者名を前に付けます。)
  • /packages/package/name: パッケージの名前(25字以内)
  • /packages/package/overview: パッケージの概要(35字以内)
  • /packages/package/description: パッケージの説明
  • /packages/package/developer: パッケージの開発者
  • /packages/package/originalDeveloper: 派生元パッケージの開発者
  • /packages/package/dependencies/dependency: 依存パッケージのID
  • /packages/package/pageURL: パッケージの紹介ページURL
  • /packages/package/downloadURL: パッケージのダウンロードページURL
  • /packages/package/downloadMirrorURL: パッケージのミラーダウンロードページURL
  • /packages/package/directURL: 一括インストール機能に使用されるURL
  • /packages/package/latestVersion: パッケージの最新バージョン
    • /packages/package/latestVersion/@continuous: 最新バージョンに追従するかどうか(デフォルト:false)
  • /packages/package/installer: インストーラーファイル名
  • /packages/package/installerArg: インストーラーに渡される引数($instpathは、インストール先フォルダに置き換えられます。)
  • /packages/package/files/file: パッケージで使用されるファイルのファイル名
    • /packages/package/files/file/@optional: インストール時に必要ないかどうか(デフォルト: false)
    • /packages/package/files/file/@installOnly: アンインストール不可のファイルかどうか(デフォルト: false)
    • /packages/package/files/file/@directory: ディレクトリかどうか(デフォルト: false)
    • /packages/package/files/file/@archivePath: ファイルのアーカイブ内相対パス(デフォルト: null)
    • /packages/package/files/file/@obsolete: 最新バージョンに存在しないかどうか(デフォルト: false)
  • /packages/package/releases/release: パッケージのリリース
    • /packages/package/releases/release/@version: そのリリースのバージョン
    • /packages/package/releases/release/archiveIntegrity: アーカイブのハッシュ
      • /packages/package/releases/release/integrities/integrity: ファイルのハッシュ
        • /packages/package/releases/release/integrities/integrity/@target: 対象のファイル名

スクリプト配布サイトのデータファイル

  • webpage: スクリプト配布サイトの一覧(Object[])
    • webpage[number].url: スクリプト配布サイトのURL(String)
    • webpage[number].developer: スクリプト配布サイトのURL(String)
    • webpage[number].description: スクリプト配布サイトの説明(String)
  • scripts: スクリプトの判別に関する配列(後ろの情報が優先されます)(Object[])
    • scripts[number].match: ダウンロードファイルのURLとの一致パターン(String)
    • packages.xmlに未登録の場合
      • scripts[number].folder: ファイルを配置するフォルダ名(scriptフォルダ下)(String)
      • scripts[number].developer: スクリプトの開発者(String)
      • scripts[number].dependencies: 依存パッケージのIDの配列(String[])
    • packages.xmlに登録済みの場合
      • scripts[number].redirect: リダイレクトするパッケージのID(String)

ID変換の対応のファイル

  • 変換前のIDをkey、変換後のIDをvalueとする。

IDの誤字や仕様変更への対応を想定しています。

変換を削除することは、基本的に禁止です。 レビュー時・マージ時には十分注意してください。