Skip to content

Commit

Permalink
Merge pull request #923 from Cysharp/feature/UpdateDocs25021203
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
mayuki authored Feb 12, 2025
2 parents 4d2aff8 + 341b8d3 commit 71f8fc9
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 14 deletions.
18 changes: 11 additions & 7 deletions docs/docs/quickstart-unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ You can create a solution, server project, and shared library project, and add M
dotnet new classlib -f netstandard2.1 -o src/%MO_PROJECT_NAME%.Shared -n %MO_PROJECT_NAME%.Shared

dotnet new sln -n %MO_PROJECT_NAME%
dotnet sln add src/%MO_PROJECT_NAME%.Server
dotnet sln add src/%MO_PROJECT_NAME%.Shared
dotnet sln add src/%MO_PROJECT_NAME%.Server --in-root
dotnet sln add src/%MO_PROJECT_NAME%.Shared --in-root

pushd src\%MO_PROJECT_NAME%.Server
dotnet remove package Grpc.AspNetCore
Expand All @@ -75,8 +75,8 @@ You can create a solution, server project, and shared library project, and add M
dotnet new classlib -f netstandard2.1 -o "src/$MO_PROJECT_NAME.Shared" -n "$MO_PROJECT_NAME.Shared"

dotnet new sln -n "$MO_PROJECT_NAME"
dotnet sln add "src/$MO_PROJECT_NAME.Server"
dotnet sln add "src/$MO_PROJECT_NAME.Shared"
dotnet sln add "src/$MO_PROJECT_NAME.Server" --in-root
dotnet sln add "src/$MO_PROJECT_NAME.Shared" --in-root

pushd "src/$MO_PROJECT_NAME.Server"
dotnet remove package Grpc.AspNetCore
Expand All @@ -98,8 +98,8 @@ You can create a solution, server project, and shared library project, and add M
dotnet new classlib -f netstandard2.1 -o src/$MO_PROJECT_NAME.Shared -n $MO_PROJECT_NAME.Shared

dotnet new sln -n $MO_PROJECT_NAME
dotnet sln add src/$MO_PROJECT_NAME.Server
dotnet sln add src/$MO_PROJECT_NAME.Shared
dotnet sln add src/$MO_PROJECT_NAME.Server --in-root
dotnet sln add src/$MO_PROJECT_NAME.Shared --in-root

pushd src/$MO_PROJECT_NAME.Server
dotnet remove package Grpc.AspNetCore
Expand Down Expand Up @@ -402,6 +402,10 @@ Next, add an Assembly Definition file to make it a separate assembly in Unity. A
}
```

:::note
The file name of the Assembly Definition file is used as the project name when opening the project from Unity. Therefore, it is recommended to add a `.Unity` suffix to distinguish it from `MyApp.Shared`.
:::

Finally, add `Directory.Build.props` and `Directory.Build.targets` to the `MyApp.Shared` project. These files are used to configure the project not to output folders such as `bin` and `obj` (instead, output to `.artifacts`) and to hide Unity-specific files from the IDE.

```xml title="src/MyApp.Shared/Directory.Build.props"
Expand Down Expand Up @@ -460,7 +464,7 @@ With these steps, the `MyApp.Shared` project should have the following file stru

`MyApp.Shared` has been made available as a local package, so you need to add a reference to the local package in the Unity project.

To add a reference to a local package, add the path to the package in `MyApp.Unity/Packages/manifest.json`. Here, add `file:../../MyApp.Shared` as the path to the package.
To add a reference to a local package, add the path to the package in `MyApp.Unity/Packages/manifest.json`. Here, add `file:../../MyApp.Shared` as the relative path to the package.

```json title="src/MyApp.Unity/Packages/manifest.json"
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Unity 6 の一部バージョンでは Source Generator に関する不具合が
dotnet new classlib -f netstandard2.1 -o src/%MO_PROJECT_NAME%.Shared -n %MO_PROJECT_NAME%.Shared

dotnet new sln -n %MO_PROJECT_NAME%
dotnet sln add src/%MO_PROJECT_NAME%.Server
dotnet sln add src/%MO_PROJECT_NAME%.Shared
dotnet sln add src/%MO_PROJECT_NAME%.Server --in-root
dotnet sln add src/%MO_PROJECT_NAME%.Shared --in-root

pushd src\%MO_PROJECT_NAME%.Server
dotnet remove package Grpc.AspNetCore
Expand All @@ -75,8 +75,8 @@ Unity 6 の一部バージョンでは Source Generator に関する不具合が
dotnet new classlib -f netstandard2.1 -o "src/$MO_PROJECT_NAME.Shared" -n "$MO_PROJECT_NAME.Shared"

dotnet new sln -n "$MO_PROJECT_NAME"
dotnet sln add "src/$MO_PROJECT_NAME.Server"
dotnet sln add "src/$MO_PROJECT_NAME.Shared"
dotnet sln add "src/$MO_PROJECT_NAME.Server" --in-root
dotnet sln add "src/$MO_PROJECT_NAME.Shared" --in-root

pushd "src/$MO_PROJECT_NAME.Server"
dotnet remove package Grpc.AspNetCore
Expand All @@ -98,8 +98,8 @@ Unity 6 の一部バージョンでは Source Generator に関する不具合が
dotnet new classlib -f netstandard2.1 -o src/$MO_PROJECT_NAME.Shared -n $MO_PROJECT_NAME.Shared

dotnet new sln -n $MO_PROJECT_NAME
dotnet sln add src/$MO_PROJECT_NAME.Server
dotnet sln add src/$MO_PROJECT_NAME.Shared
dotnet sln add src/$MO_PROJECT_NAME.Server --in-root
dotnet sln add src/$MO_PROJECT_NAME.Shared --in-root

pushd src/$MO_PROJECT_NAME.Server
dotnet remove package Grpc.AspNetCore
Expand Down Expand Up @@ -400,6 +400,10 @@ Unity クライアントから API を呼び出すためにサービス定義を
}
```

:::note
Assembly Definition ファイルのファイル名は Unity から IDE を開く際のプロジェクト名として使用されます。そのためサーバー向けの `MyApp.Shared` と区別がつくよう `.Unity` サフィックスを付けることを推奨します。
:::

最後に `MyApp.Shared` プロジェクトに `Directory.Build.props``Directory.Build.targets` を追加します。これは .NET プロジェクトで `bin`, `obj` フォルダーを出力しないように構成(代わりに `.artifacts` に出力)し、Unity 向けの .meta などのファイルを IDE 上から非表示にします。


Expand Down Expand Up @@ -459,7 +463,7 @@ macOS の Finder ではデフォルトで `.` から始まるファイルを非

`MyApp.Shared` をローカルパッケージとして共有できるようにしたので Unity プロジェクトでローカルパッケージの参照を追加する必要があります。

ローカルパッケージの参照を追加するには `MyApp.Unity/Packages/manifest.json` にパッケージへのパスを追加します。ここでは `file:../../MyApp.Shared` として追加します
ローカルパッケージの参照を追加するには `MyApp.Unity/Packages/manifest.json` にパッケージへのパスを追加します。ここでは `file:../../MyApp.Shared` として相対パスで追加します

```json title="src/MyApp.Unity/Packages/manifest.json"
{
Expand Down
Binary file modified docs/static/img/docs/fig-quickstart-unity-server-sln.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 71f8fc9

Please sign in to comment.