Skip to content

Commit

Permalink
Mod READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
nowsprinting committed Mar 16, 2024
1 parent 9ee07c4 commit 200591a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,27 @@ Open the AutopilotSettings file you wish to run in the inspector and click the *
After the set run time has elapsed, or as in normal play mode, clicking the Play button will stop the program.


### 2. Run from commandline
### 2. Run from Play Mode test

Autopilot works within your test code using the async method `LauncherFromTest.AutopilotAsync(string)`.
Specify the `AutopilotSettings` file path as the argument.

```
[Test]
public async Task LaunchAutopilotFromTest()
{
await LauncherFromTest.AutopilotAsync("Assets/Path/To/AutopilotSettings.asset");
}
```

> [!NOTE]
> If an error is detected in running, it will be output to `LogError` and the test will fail.
> [!WARNING]
> The default timeout for tests is 3 minutes. If the autopilot execution time exceeds 3 minutes, please specify the timeout time with the `Timeout` attribute.

### 3. Run from commandline

To execute from the commandline, specify the following arguments.

Expand Down
22 changes: 21 additions & 1 deletion README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,27 @@ Slack通知に付与するメンションを設定します。
設定された実行時間が経過するか、通常の再生モードと同じく再生ボタンクリックで停止します。


### 2. コマンドラインから実行
### 2. Play Modeテストから実行

非同期メソッド `LauncherFromTest.AutopilotAsync(string)` を使用することで、テストコード内でオートパイロットが動作します。
引数には `AutopilotSettings` ファイルパスを指定します。

```
[Test]
public async Task LaunchAutopilotFromTest()
{
await LauncherFromTest.AutopilotAsync("Assets/Path/To/AutopilotSettings.asset");
}
```

> [!NOTE]
> 実行中にエラーを検知すると `LogError` が出力されるため、そのテストは失敗と判定されます。
> [!WARNING]
> テストのデフォルトタイムアウトは3分です。オートパイロットの実行時間が3分を超える場合は `Timeout` 属性でタイムアウト時間を指定してください。

### 3. コマンドラインから実行

コマンドラインから実行する場合、以下の引数を指定します。

Expand Down

0 comments on commit 200591a

Please sign in to comment.