datの更新チェックの仕様

この記事はdatを配布する人向けの記事です。

ちょっとめんどうになったので、かなり手を抜いて書きます。後日修正するかもしれません。

概要

自作したdatの更新チェックやホームページや配布ページを開けるようにするための説明です。

datを独自に配布するための手順

  1. datにpackage.xmlを含める
  2. 自分が管理するwebサイトに更新チェックファイルを設置する
datにpackage.xmlを含める

作成したdatと一緒にpackage.xmlを配布してください。中身は見たら大体わかると思うので、大事な部分だけ説明しておきます。

idタグ

現在は使っていませんが、他の人が配布しているdatと重複しないようなIDを設定してください。

nameタグ

バージョン情報などで表示されるdatの表示名です。自分のdatの名前を設定してください。

versionタグ

このdatのバージョンです。更新チェックで使用するバージョンはこのバージョンです。

書式は「(メジャーバージョン).(マイナーバージョン)」になります。

使用できる文字は数字のみで、新しいバージョンは古いバージョンより数値的に大きくなるように設定してください。

formatVersionタグ

このdatの仕様のバージョンです。対応する本体に付属しているDefine.xmlのDAT_FORMAT_VERSIONと同じ値を設定してください。

もちろんですが、このバージョンの値を変更するときは、配布するdatの仕様も新しいものに変更してください。

homepageタグ

配布元の設定です。nameタグがバージョン情報などで表示される配布元の表示名で、urlタグがそのリンクなどで表示されるWebページのURLです。

nameタグは必須ですが、urlタグは必須ではありません。

repositoryタグ

datを管理している場所を指定します。現在は更新チェックでしか使用していません。

urlタグに設定するURLは自分が管理しているwebサイトのURLにしてください。更新チェックではこのURLの直下に配置されたversionというファイルを読み込みます。

urlタグが設定されていない場合や、datの更新チェックは行いません。

更新チェックファイルの設置

package.xmlrepositoryタグで設定したURLにversionという名前のファイルを設置してください。

このファイルは1行目に最新のバージョン、2行目に配布ページのURL*1を記入します。ファイルの改行コードはCR+LFでもLFでも良いです。文字コードはたぶんUTF-8*2です。

配布ページのURLがない場合は、更新チェック時にはpackage.xmlの配布元サイトのURLを開きます。

更新履歴

  • 2017/08/19
    • 初版

*1:ver20170819から対応

*2:今はマルチバイト文字が含まれないので文字コードはあまり意識していません。