anoyetta の開発記録

FINAL FANTASY XIV 向けのプラグイン「補助輪」の開発をしています。セットアップ、便利な使い方、その他デバイスなどの情報を扱っています。

補助輪の公式アップデート手順

はじめに

このページは、補助輪(Hojoring)の開発者である anoyetta 本人による FFXIV向け ACT(Advanced Combat Tracker)の公式アップデート手順を案内しています。

github.com

原則

原則として「丸ごと上書きする」です。
余程の大きな変更でない限り最新バージョンをダウンロードして丸ごと上書きするだけでいいようになっています。
大きな変更によって特殊な操作をしなければならない場合はその旨をリリースノートに書いています。そのような特別な注意書きがない場合は前述の通り「丸ごと上書き」してください。

アップデート方法

手段は3つあります。簡単なほうから順番に A, B, C と呼称します。
そうはいってもそれぞれの難易度に大きく差があるわけではありません。最も確実なのは自分で全てを管理するプランCです。うまくいかない場合はプランCを実行しましょう。

その前にバックアップ!

何をするにもその前にとにかくバックアップです。IT屋は新人時代にひたすら叩き込まれます。
安全を確認したらバックアップを消したら良いのです。バックアップしておいて困ることはない。バックアップがなくて泣くことは大いにある。
何をするにもとにかくバックアップしてから です。最初の作業がバックアップ。
ディレクトリ構成は ACTおよび補助輪のインストール(完全版)に準拠しているものとします。独自の構成の方は適宜読み替えてください。

バックアップの取り方

  1. バックアップ前の状態
    f:id:anoyetta:20210527120728j:plain

  2. Hojoringディレクトリを丸ごとコピーする
    f:id:anoyetta:20210527120733j:plain

  3. コピーしたディレクトリを Hojoring_back にリネームする
    f:id:anoyetta:20210527120724j:plain

これだけです。こうしておけば何かあっても簡単に元のバージョンに戻せます。

バックアップの戻し方(復元方法)

  1. 復元前の状態
    f:id:anoyetta:20210527120724j:plain

  2. Hojoring ディレクトリを Hojoring_new にリネームする
    f:id:anoyetta:20210527120741j:plain

  3. Hojoring_back ディレクトリを Hojoring にリネームする f:id:anoyetta:20210527120745j:plain

解説

ACTは Hojoring ディレクトリに配置されているDLLをロードしています。よってアップデートなどによって問題が生じた Hojoring ディレクトリを別の名前にして逃します。その後以前の状態そのままである Hojoring_backHojoring にリネームすることで以前のバージョンを参照させます。

おさらい
HojoringHojoring_new にしてロードされないようにする
Hojoring_backHojoring にして現役に復帰させる
これで元の状態に戻る。

プランA「Helpからアップデートする」

  1. Help タブを開いて [アップデートする] をクリックする
    f:id:anoyetta:20210527120749j:plain

※ 最新のアップデートについて十分な動作実績が得られていない場合はプレリリースにしています。パッチ直後など、急速に新しいバージョンが必要な場合は [プレリリース版を使用する] にチェックを入れてプレリリース版をインストールしましょう。

  1. リリースノートを確認する
    f:id:anoyetta:20210527120758j:plain
    次の PowerShell プロンプト の表示が出た暫く後にブラウザが立ち上がり、上図のように対象バージョンのリリースノートが表示されます。
    リスキーな修正やユーザ側で対応が必要な場合はその旨が記載されています。よく読んで理解したら次に進みます。

  2. PowerShell プロンプト で y を入力する
    f:id:anoyetta:20210527120804j:plain
    もちろんアップデートしないならば、n を入力しましょう。

  3. 何かキーを入力してアップデートを終了する
    f:id:anoyetta:20210527120809j:plain
    問題がなければスクリプトが流れて上図のようにアップデートが完了します。何かキーを入力してアップデートスクリプトを終了させます。

プランB「アップデートスクリプトを直接実行する」

  1. update_hojoring.ps1 を右クリックする
    f:id:anoyetta:20210527120818j:plain

  2. [プログラムから開く] → [Windows PowerShell] を選択する
    f:id:anoyetta:20210527120823j:plain

  3. 以降は プランA と同じ

プレリリース版を使いたい

コマンドライン引数を指定しましょう。
[ファイル名を指定して実行] に powershell と入力して実行します。
PowerShell が起動したら下記のコマンドを入力します。

cd D:\app\ACTv3\plugin\Hojoring
.\update_hojoring.ps1 true

1行目は補助輪のインストールディレクトリへの移動を意味します。インストールディレクトリが異なる場合は適宜読み替えてください。

プランC「手動でアップデートする」

  1. 最新版をダウンロードして解凍する
    github.com

  2. 解凍した最新版一式を Hojoring ディレクトリに上書きコピーする
    f:id:anoyetta:20210527120828j:plain

FAQ

Q1. アップデートスクリプトでエラーが発生してアップデートできません

A. プランC を実行しましょう。

Q2. バックアップを復帰させたが設定が元に戻らない

A. 設定は別のディレクトリに保存されています。したがって設定は元に戻りません。単純にDLLのアップデートを行ったからDLLのアップデートを戻すということをやっているだけです。補助輪の設定ファイルは原則的に互換性を保つようにしています。したがってバックアップの復帰時に設定ファイルをもとに戻す必要は原則的にありません。
それでも設定ファイルのバックアップ、復帰などを試みたい方は次回の記事で取り上げる予定ですので そちら をご覧ください。

Q3. 手順通りやったがうまくアップデートできない!動かない!なんとかしろ!

A. ほとんど場合は手順通りやったつもりでやれていない、先入観などによって手順を飛ばしているか間違えているケースです。手順通りやるとは厳密には 印刷して一行ずつチェックを入れながら実施する ものです。
それでもどうしても解決しないならば、Discordなどで救援を依頼してもらえればリモートで対応いたします。
あくまでも全ては自己責任であることをご理解ください。

©2019 anoyetta