Skip to content

Commit 8a02d41

Browse files
scarletcafescarletcafe
committed
Translate getting-started and add some minor text to manual build doc
1 parent 7684295 commit 8a02d41

File tree

3 files changed

+149
-2
lines changed

3 files changed

+149
-2
lines changed

‎documentation/source/en/building-manually.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ To get started, clone the TASauria repository.
1919
git clone --recurse-submodules https://github.com/scarletcafe/tasauria
2020
```
2121

22+
If you have already cloned but forgotten to use the submodules flag, you can pull the submodules like so:
23+
24+
```bash
25+
git submodule init
26+
git submodule update --recursive
27+
```
28+
2229
## Managing and building BizHawk
2330

2431
The TASauria repository has BizHawk cloned into the repository root as a submodule. This allows the targeted BizHawk version to be easily updated or changed, and ensures that both the location of BizHawk's built libraries and the `EmuHawk` executable are in consistent locations for MSBuild and Visual Studio.

‎documentation/source/en/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The folder structure should look something like this:
3737
You can then start `EmuHawk`.
3838
If the plugin is functioning correctly, you will be able to find the `TASauria` entry in the `Tools` > `External Tool` menu.
3939

40-
TASauria begins running by default even without the window open. However, you can use the window to adjust settings, such as what host and port it listens for clients on.
40+
You can adjust various settings from the window that appears.
4141

4242
Once you have confirmed that the plugin is functioning, you can move onto the next step.
4343

‎documentation/source/ja/getting-started.md‎

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,144 @@
11

22
# はじめに
33

4-
TODO
4+
5+
TASauriaは、BizHawkエミュレーターをリモート制御するためのプラグインとPythonライブラリです。
6+
7+
始めるには、まず、BizHawkエミュレーターをセットアップしましょう。
8+
9+
## Step 1. BizHawkをインストール {#bizhawk}
10+
11+
BizHawkのダウンロードは、[BizHawkのGitHubリリースページ](https://github.com/TASEmulators/BizHawk/releases/)からできます。
12+
13+
BizHawkバージョンずつ、対応しているTASauriaのプラグインファイルがあるから、どのバージョンをダウンロードしたのか覚えておいてください。
14+
15+
アーカイブを展開して、BizHawkのエミュレーターを使用するには `EmuHawk`という実行ファイルを起動してください。
16+
BizHawkは、複数のプラットフォームとコアを対応しているから、もっと詳しく知りたい場合は[ウィキページ](https://tasvideos.org/Bizhawk)を参照してください。
17+
18+
エミュレーターの動作を確認し、進む前に設定を好きに調整してください。
19+
20+
## Step 2. TASauriaプラグインをインストール {#plugin}
21+
22+
TASauriaプラグインのビルドは、 [TASauriaのGitHubリリースページ](https://github.com/scarletcafe/tasauria/releases) から取得できます。
23+
24+
BizHawkでプラグインを使用するには、 `.dll` ファイルを `EmuHawk`の隣となる`ExternalTools`のフォルダーに置く必要があります。他に外部ツールをもっていない、それとも BizHawk を使い始めたばかりの場合は、このフォルダーは存在しなく、自分で作成しないといけないかもしれません。
25+
26+
フォルダーの構造は以下の通りになります：
27+
28+
```ansi
29+
📁 BizHawk
30+
├─ 📁 dll
31+
├─ 📁 ExternalTools
32+
│ └─ TASAuriaPlugin.dll
33+
├─ ... (other folders)
34+
├─ DiscoHawk.exe
35+
├─ EmuHawk.exe
36+
└─ ... (other files)
37+
```
38+
39+
正常に配置したら、 `EmuHawk`を起動できます。
40+
プラグインは正しく検出されたら、`Tools` > `External Tool` から `TASauria` の項目が表示されて、それから起動できます。
41+
42+
TASauriaのウィンドウからいろんな設定を調整できます。
43+
44+
プラグインが正しく動作していることを確認したら、次のステップに進んでください。
45+
46+
::: info
47+
プラグインのリリースバージョンの使用を強くお勧めします。けれど、ある時、例えばまだリリースに出ていない機能やバグの修正が必要な場合、開発版を試したくなる時があるかもしれません。
48+
49+
[GitHub Actions のワークフロー](https://github.com/scarletcafe/tasauria/actions)　にプラグインのアルファ版が常にコンパイルしてアップロードされています。 このワークフローのアーティファクトページから、該当するビルドをダウンロードできます。
50+
51+
このビルドは安定さの保証がありませんから、長期的に使用することはおすすめしません。もしバグがでたら、[イシュートラッカー](https://github.com/scarletcafe/tasauria/issues)　で報告してください。
52+
:::
53+
54+
## Step 3. Pythonをインストール {#python}
55+
56+
Pythonはすでにパソコンにインストールされていない場合は、インストールする必要があります。
57+
58+
WindowsとmacOSでは、Pythonの[公式ウェブサイト](https://www.python.org/downloads/)からダウンロードすることが一番簡単なやり方です。
59+
60+
Linuxでは、ディストリビューションのパッケージマネージャからインストールするか、[`pyenv`](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation)などのPythonのインストールを管理するツールを使えば適切なバージョンを取得できます。
61+
62+
TASauriaのPythonパッケージは、Python 3.8以上を対応としています。
63+
64+
Python が正しく導入され、pip（Python パッケージマネージャー）が利用可能か確認すべきです。Linux で `pip` コマンド単体を使うだけでは動作しない場合があり、その場合は別のパッケージ（例: `python3-pip`）もインストールする必要があります。
65+
66+
Pythonと`pip`のバージョンはこうやって確認できます：
67+
68+
::: code-group
69+
70+
```powershell [Windows]
71+
py -3 -m pip -V
72+
```
73+
74+
```bash [Linux]
75+
python3 -m pip -V
76+
```
77+
78+
:::
79+
80+
## Step 4. tasauriaのPythonパッケージをインストール {#module}
81+
82+
Python の環境は完了したら、`tasauria` パッケージをこうやって PyPI から入手できます：
83+
84+
::: code-group
85+
86+
```powershell [Windows]
87+
py -3 -m pip install -U tasauria
88+
```
89+
90+
```bash [Linux]
91+
python3 -m pip install -U tasauria
92+
```
93+
94+
:::
95+
96+
> [!WARNING]
97+
> `tasauria`パッケージをインストールしようとしている時は、特に管理者としてPythonをインストールした場合か、Linuxでパッケージマネージャからインストールした場合には、権限に関するエラーが出るかもしれません。
98+
>
99+
> 一番シンプルな回避策は、仮想環境を作成することです。仮想環境を使えば、パッケージはシステムと別のフォルダーにインストールされ、権限のエラーを避けられます。
100+
>
101+
> 仮想環境について学ぶには、[Pythonのドキュ](https://docs.python.org/ja/3/library/venv.html)を閲覧することがお勧めします。ですけど、簡単の説明は以下の通りです：
102+
>
103+
> #### 仮想環境の作成
104+
>
105+
> これは、`tasauria_environment`と名付けられたフォルダーの中に仮想環境を作成します：
106+
>
107+
> ::: code-group
108+
>
109+
> ```powershell [Windows]
110+
> py -3 -m venv tasauria_environment
111+
> ```
112+
>
113+
> ```bash [Linux]
114+
> python3 -m pip install -U tasauria
115+
> ```
116+
>
117+
> :::
118+
>
119+
> #### 仮想環境をアクティベート化
120+
> ::: code-group
121+
>
122+
> ```powershell [Windows (PowerShell)]
123+
> .\tasauria_environment\Scripts\Activate.ps1
124+
> ```
125+
>
126+
> ```cmd [Windows (cmd)]
127+
> .\tasauria_environment\Scripts\activate.bat
128+
> ```
129+
>
130+
> ```bash [Linux]
131+
> source tasauria_environment/bin/activate
132+
> ```
133+
>
134+
> :::
135+
>
136+
> #### パッケージをインストール
137+
>
138+
> ```bash
139+
> python -m pip install -U tasauria
140+
> ```
141+
>
142+
> これからは、作成時間と同じフォルダーから仮想環境をアクティベートし、TASauriaを使うスクリプトを実行できます。
143+
144+
`pip`は、自動にパッケージとその依存のインストールを管理します。インストールが終わったら、TASauriaを使うスクリプトは実行可能となります。

0 commit comments

Comments
 (0)