UpdateChecker
車両・路線データのアップデート情報を受信できるようにするプラグインです。
AtsEX車両プラグイン、またはマッププラグインとして使用可能です。
プラグインの特長
シナリオ読込と同時にデータが最新版であるかどうかを確認し、アップデートが配信されている場合はその詳細を通知します。 せっかくデータを更新したのに、ユーザーに気付いてもらえない……というリスクを極限まで減らすことができます。
アップデート情報の配信元としては、WebサーバーのURLを直接指定する方法の他、GitHub上にアップされたリポジトリと同期することも可能です。
プラグインを組み込む手順
1a. 【車両データに組み込む場合】プラグインを車両に配置する
下のボタンよりダウンロードしたファイルをゾーン識別子を削除した上で解凍し、車両ファイル(Vehicle.txtなど)に対する位置関係が次の画像のようになるように配置します。
ゾーン識別子の削除を忘れずに!
この手順を飛ばしたままパッケージを解凍してしまうと、不可解なエラーの原因となる場合があります。
そのままパッケージを解凍し、プラグインを配置してしまった場合は、ゾーン識別子を削除した上でもう一度解凍からやり直してください。
ゾーン識別子を削除する方法については、手動でのパッケージの適用方法 - AtsEXインストールガイドの「1-1. ゾーン識別子を削除する」をご参照ください。
既にVehiclePluginUsing.xmlなどのAtsEX車両プラグインリストファイルが存在する場合
本プラグインに同梱のVehiclePluginUsing.xmlは使用せず、既存のプラグインリストファイルに以下のコードを追記してください。
<Assembly Path="AtsExPlugins\UpdateChecker.dll" />
1b. 【路線データに組み込む場合】プラグインをマップに配置する
1b-1. プラグインリストファイルを配置する
下のボタンよりダウンロードしたファイルをゾーン識別子を削除した上で解凍し、マップファイル(Map.txtなど)に対する位置関係が次の画像のようになるように配置します。
1b-2. マップファイルにプラグインリストを指定する
マップファイルを開き、次の例のように冒頭へ AtsEx::USEATSEX
ヘッダー(または AtsEx::NOMPI
ヘッダーでも可)、AtsEx::MapPluginUsing
ヘッダーを追記します。
ゾーン識別子の削除を忘れずに!
この手順を飛ばしたままパッケージを解凍してしまうと、不可解なエラーの原因となる場合があります。
そのままパッケージを解凍し、プラグインを配置してしまった場合は、ゾーン識別子を削除した上でもう一度解凍からやり直してください。
ゾーン識別子を削除する方法については、手動でのパッケージの適用方法 - AtsEXインストールガイドの「1-1. ゾーン識別子を削除する」をご参照ください。
既にMapPluginUsing.xmlなどのAtsEXマッププラグインリストファイルが存在する場合
本プラグインに同梱のMapPluginUsing.xmlは使用せず、既存のプラグインリストファイルに以下のコードを追記してください。
<Assembly Path="MapPlugins\UpdateChecker.dll" />
2. 各種情報を設定ファイルに記述する
アップデート情報の配信元などの情報をUpdateChecker.Config.xmlに記述します。
設定ファイルの文法は以下を参照してください。
設定ファイルの文法
コードの例
各要素・属性の解説
要素・属性 | 初期値 | 内容 |
---|---|---|
Version | 0.0 |
このデータのバージョン。x.x 、x.x.x 、x.x.x.x のいずれかのフォーマットで指定(例: 2.1 、1.13.8302.17460 )
|
ThemeColor | #0000A0 |
アップデート情報ダイアログのヘッダー部分の背景色。 以下のいずれかで指定
|
DownloadUrl | サンプルURL | アップデート情報ダイアログで[ダウンロードページへ]ボタンが押されたときに表示するURL |
Source(要素) | ||
├ HttpRequest(要素) | HttpRequestとGitHubRepositoryのいずれか1つを定義 | |
│├ VersionUrl | サンプルURL | 最新バージョンをテキスト形式で返すURL |
│└ UpdateInfoUrl | サンプルURL | アップデートの詳細情報をMarkdown形式で返すURL |
└ GitHubRepository(要素) | HttpRequestとGitHubRepositoryのいずれか1つを定義 | |
├ Owner | - | リポジトリの所有者名(例:automatic9045 ) |
└ Name | - | リポジトリ名(例:AtsEX ) |
ライセンス
本ソフトウェアは、The MIT License modified with Commons Clause v1.0のもとで使用を許諾されています。
このライセンスにおいて許可されない方法での使用を希望される場合は、個別対応となりますので、お問い合わせください。
ライセンスの要約
以下の要約は正確な表現ではありません。 正式な文面はGitHub リポジトリのLICENSE.txtを参照してください。
- 原則として本ソフトウェアは自由に改変・使用することができます。
- ただし、本ソフトウェアを販売することはできません。
- また、本ソフトウェアを使った作品には、本ソフトウェアを使用している旨の著作権表示が必要です。
- 本ソフトウェアを使用したことにより何かしらの損害を受けたとしても、作者は一切の責任を負わないものとします。