はじめに

TASauriaは、BizHawkエミュレーターをリモート制御するためのプラグインとPythonライブラリです。

始めるには、まず、BizHawkエミュレーターをセットアップしましょう。

Step 1. BizHawkをインストール

BizHawkのダウンロードは、BizHawkのGitHubリリースページからできます。

BizHawkバージョンずつ、対応しているTASauriaのプラグインファイルがあるから、どのバージョンをダウンロードしたのか覚えておいてください。

アーカイブを展開して、BizHawkのエミュレーターを使用するには EmuHawkという実行ファイルを起動してください。 BizHawkは、複数のプラットフォームとコアを対応しているから、もっと詳しく知りたい場合はウィキページを参照してください。

エミュレーターの動作を確認し、進む前に設定を好きに調整してください。

Step 2. TASauriaプラグインをインストール

TASauriaプラグインのビルドは、 TASauriaのGitHubリリースページ から取得できます。

BizHawkでプラグインを使用するには、 .dll ファイルを EmuHawkの隣となるExternalToolsのフォルダーに置く必要があります。他に外部ツールをもっていない、それとも BizHawk を使い始めたばかりの場合は、このフォルダーは存在しなく、自分で作成しないといけないかもしれません。

フォルダーの構造は以下の通りになります：

📁 BizHawk
├─ 📁 dll
├─ 📁 ExternalTools
│   └─ TASAuriaPlugin.dll
├─ ... (other folders)
├─ DiscoHawk.exe
├─ EmuHawk.exe
└─ ... (other files)

正常に配置したら、 EmuHawkを起動できます。 プラグインは正しく検出されたら、Tools > External Tool から TASauria の項目が表示されて、それから起動できます。

TASauriaのウィンドウからいろんな設定を調整できます。

プラグインが正しく動作していることを確認したら、次のステップに進んでください。

INFO

プラグインのリリースバージョンの使用を強くお勧めします。けれど、ある時、例えばまだリリースに出ていない機能やバグの修正が必要な場合、開発版を試したくなる時があるかもしれません。

GitHub Actions のワークフロー　にプラグインのアルファ版が常にコンパイルしてアップロードされています。 このワークフローのアーティファクトページから、該当するビルドをダウンロードできます。

このビルドは安定さの保証がありませんから、長期的に使用することはおすすめしません。もしバグがでたら、イシュートラッカー　で報告してください。

Step 3. Pythonをインストール

Pythonはすでにパソコンにインストールされていない場合は、インストールする必要があります。

WindowsとmacOSでは、Pythonの公式ウェブサイトからダウンロードすることが一番簡単なやり方です。

Linuxでは、ディストリビューションのパッケージマネージャからインストールするか、pyenvなどのPythonのインストールを管理するツールを使えば適切なバージョンを取得できます。

TASauriaのPythonパッケージは、Python 3.8以上を対応としています。

Python が正しく導入され、pip（Python パッケージマネージャー）が利用可能か確認すべきです。Linux で pip コマンド単体を使うだけでは動作しない場合があり、その場合は別のパッケージ（例: python3-pip）もインストールする必要があります。

Pythonとpipのバージョンはこうやって確認できます：

Windows

py -3 -m pip -V

Linux

python3 -m pip -V

Step 4. tasauriaのPythonパッケージをインストール

Python の環境は完了したら、tasauria パッケージをこうやって PyPI から入手できます：

Windows

py -3 -m pip install -U tasauria

Linux

python3 -m pip install -U tasauria

WARNING

tasauriaパッケージをインストールしようとしている時は、特に管理者としてPythonをインストールした場合か、Linuxでパッケージマネージャからインストールした場合には、権限に関するエラーが出るかもしれません。

一番シンプルな回避策は、仮想環境を作成することです。仮想環境を使えば、パッケージはシステムと別のフォルダーにインストールされ、権限のエラーを避けられます。

仮想環境について学ぶには、Pythonのドキュを閲覧することがお勧めします。ですけど、簡単の説明は以下の通りです：

仮想環境の作成

これは、tasauria_environmentと名付けられたフォルダーの中に仮想環境を作成します：

Windows

py -3 -m venv tasauria_environment

Linux

python3 -m pip install -U tasauria

仮想環境をアクティベート化

Windows (PowerShell)

.\tasauria_environment\Scripts\Activate.ps1

Windows (cmd)

.\tasauria_environment\Scripts\activate.bat

Linux

source tasauria_environment/bin/activate

パッケージをインストール

python -m pip install -U tasauria

これからは、作成時間と同じフォルダーから仮想環境をアクティベートし、TASauriaを使うスクリプトを実行できます。

pipは、自動にパッケージとその依存のインストールを管理します。インストールが終わったら、TASauriaを使うスクリプトは実行可能となります。