Skip to content

Commit

Permalink
Merge pull request #928 from Cysharp/feature/UpdateDocs25021303
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
mayuki authored Feb 13, 2025
2 parents 61f2484 + 7b5509c commit fc52019
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/docs/quickstart-unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ After extracting the source code, run `init.cmd` or `init.sh` with an arbitrary

After running the script, you can delete `init.sh` and `init.cmd` and `tools/RepoInitializer` that actually perform the rewriting process.

- Open `src/MyApp.Unity` as a Unity project from Unity Hub.
- Sample implementation is included in `SampleScene`.
- To open the project, select `Assets` -> `Open C# Project` from the menu in the Unity Editor.
- To run the server, start the `MyApp.Server` project in Visual Studio or Rider.

The template is configured based on the contents of this quick start guide, so refer to this guide for details.

### License
The repository is provided under the [CC0 - Public Domain](https://creativecommons.org/publicdomain/zero/1.0/) license.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Unity 6 の一部バージョンでは Source Generator に関する不具合が
:::

## セットアップ済みテンプレートを使用する (オプション)
このガイドではプロジェクトの作成やパッケージのインストールといった手順を解説しています。すべての手順が完了した状態のテンプレートを [MagicOnion.Template.Unity](https://github.com/Cysharp/MagicOnion.Template.Unity) リポジトリから取得できます
このガイドではプロジェクトの作成やパッケージのインストールといったセットアップの手順を解説しています。これらのセットアップをスキップしてすぐに始めたい方のために、セットアップ完了済みのテンプレートとなる [MagicOnion.Template.Unity](https://github.com/Cysharp/MagicOnion.Template.Unity) リポジトリを公開しています

テンプレートを使用した開発は GitHub からリポジトリをアーカイブファイルとしてダウンロードするか、[GitHub のテンプレートからリポジトリーを作成する方法](https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)で開始できます。

Expand Down Expand Up @@ -53,7 +53,7 @@ GitHub からアーカイブファイルをダウンロードして展開する
</TabItem>
</Tabs>

ソースコードを手元に用意した後、リポジトリールートに含まれる `init.cmd` または `init.sh` に任意のプロジェクト名 (例 `MyApp` など) 指定して実行してください。このスクリプトはリポジトリのプロジェクトやファイルのリネームなどの準備処理を行います
ソースコードを手元に用意した後、リポジトリールートに含まれる `init.cmd` または `init.sh` に任意のプロジェクト名 (例 `MyApp` など) 指定して実行してください。このスクリプトはリポジトリーのプロジェクトやファイルのリネームなどの準備処理を行います

<Tabs groupId="shell">
<TabItem value="cmd" label="Windows (cmd.exe)" default>
Expand All @@ -73,7 +73,13 @@ GitHub からアーカイブファイルをダウンロードして展開する
</TabItem>
</Tabs>

実行後は `init.sh` および `init.cmd`、実際の書き換え処理を行う `tools/RepoInitializer` を削除できます。
実行後は `init.sh` および `init.cmd`、準備処理を行う `tools/RepoInitializer` を削除できます。準備処理を行った後は Unity Hub から `src/MyApp.Unity` ディレクトリを Unity プロジェクトとして開いてください。

- サンプル実装は `SampleScene` に含まれています
- Unity Editor 起動後にメニューから `Assets` -> `Open C# Project` で Visual Studio または Rider でサーバーも含めたプロジェクトを開けます
- サーバーの起動は Visual Studio または Rider で `MyApp.Server` を実行してください

テンプレートはこのクイックスタートガイドの内容に準じた構成となっているため、詳細についてはこのガイドを参照してください。

### ライセンス
テンプレートは [CC0 - パブリックドメイン](https://creativecommons.org/publicdomain/zero/1.0/) で提供されます。
Expand Down

0 comments on commit fc52019

Please sign in to comment.