Skip to content

README.ja.md

Latest commit

 

History

History
174 lines (132 loc) · 11.1 KB

README.ja.md

File metadata and controls

174 lines (132 loc) · 11.1 KB

GitHub Actions Releases

SlnMerge

Unity でソリューションファイル生成時に指定したソリューションをマージするエディタ拡張です。

Unity とは別にサーバーサイドの C# プロジェクトおよびソリューションがあるようなケースで、Unity のソリューションで同時に開くことができるようになります。

Table of Contents

動作確認環境

  • Unity 2022.3+
  • Windows 11 & macOS 10.15
  • Microsoft Visual Studio 2022/2026
  • JetBrains Rider 2025.x

レガシーソリューションフォーマット (.sln) とモダンなソリューションフォーマット (.slnx) の両方に対応しています。

インストール

Package Manager を使用して git リポジトリからパッケージをインストールできます。

Package Manager: Add packages from git URL...

https://github.com/Cysharp/SlnMerge.git?path=src#{Version}

Note

{Version} は 2.0.0 のようにリリースバージョンを指定してください。省略された場合はメインブランチが使用され、安定しない可能性があります。

SlnMerge の設定 (Unity Editor から)

Unity Editor の Preferences から SlnMerge を選択することで設定画面を開けます。この Preferences の設定項目はプロジェクトごとのユーザーの設定項目として保存されます。

Unity Editor: Preferences -> SlnMerge

  • SlnMerge settings file: ソリューションのマージ設定ファイル (.mergesettings) を選択できます。デフォルトでは自動でソリューション名に基づいたファイルが選択されます
  • Processing Policy Override: ソリューションの処理ポリシーを上書きします。デフォルトでは .mergesettings ファイルの設定が使用されます
  • Verbose Logging: 詳細なログを出力します
  • Edit current merge settings: 現在選択されているマージ設定ファイルをエディタで開きます。存在しない場合には編集時に作成されます
  • Regenerate Solution file: ソリューションファイルを再生成します

詳細なソリューションのマージ設定は Edit current merge settings ボタンを押して開く設定画面で行います。

ソリューションのマージ設定 (.mergesettings) はプロジェクトで共有されます。設定項目について詳しくはソリューションのマージ設定項目を参照してください。

SlnMerge の設定 (.mergesettings を編集する)

Unity Editor からの設定以外にも .mergesettings ファイルを作成し編集することでも設定可能です。Unity によって生成されるソリューションファイル名に .mergesettings をつけた名前の設定ファイルを用意します。

例えば MyUnityApp プロジェクトの場合は MyUnityApp.sln が生成されるので MyUnityApp.sln.mergesettings ファイルを作成します。

Note

.slnx フォーマットを使用している場合には以降の .sln は .slnx と読み替えてください。.sln が指定されている場合、.slnx をフォールバック対象として取り扱います。

<SlnMergeSettings>
    <MergeTargetSolution>..\MyUnityApp.Server.sln</MergeTargetSolution>
</SlnMergeSettings>

Note

MergeTargetSolution 要素が存在しないか要素の内容が空の場合には暗黙的に空のソリューションとマージされます。これはフォルダー分けの機能のみを使用したい場合に役立ちます。

ソリューションのマージ設定項目

mergesettings ファイルには次の設定項目があります。

  • MergeTargetSolution: マージしたいソリューションのパス
  • NestedProjects: ネストするプロジェクトを指定します。通常ソリューションフォルダーとして利用します
    • NestedProject/FolderPath: ソリューション上のフォルダーパス (存在しない場合は生成)
    • NestedProject/ProjectName: プロジェクト名
      • ワイルドカードを使用可能です (?, *)
  • ProjectConflictResolution: マージ元とマージ先でソリューション内に同名のプロジェクトがある場合の処理方法 (PreserveAll, PreserveUnity, PreserveOverlay) (デフォルト: PreserveUnity)
    • PreserveAll: すべてのプロジェクトを残します (Unity とマージ対象のソリューションのプロジェクトの両方)
    • PreserveUnity: Unity が生成したソリューションのプロジェクトを残します (マージ対象のソリューションのプロジェクトを破棄)
    • PreserveOverlay: 上書きするソリューションのプロジェクトを残します (Unity が生成したソリューションのプロジェクトを破棄)
  • DefaultProcessingPolicy: ソリューションの処理ポリシー (デフォルト: Merge)
    • Merge: マージ処理を行います (デフォルト)
    • NestedProjectOnly: プロジェクトのソリューションフォルダーへのネスト処理のみを行います
    • Disabled: マージ処理をスキップします

ソリューションフォルダーに追加する

NestedProjects 設定を使用するとマージ後にプロジェクトをソリューションフォルダーへ移動できます。ベースのソリューションにソリューションフォルダーが存在しない場合には自動で追加します。

<SlnMergeSettings>
    <MergeTargetSolution>..\ChatApp.Server.sln</MergeTargetSolution>
    <NestedProjects>
        <NestedProject ProjectName="Assembly-CSharp" FolderPath="Unity" />
        <NestedProject ProjectName="Assembly-CSharp-Editor" FolderPath="Unity" />
    </NestedProjects>
</SlnMergeSettings>

トラブルシューティング

常にソリューションファイルが再生成され、Visual Studioに競合ダイアログが表示される

  1. Unity Editor を閉じる
  2. Unity Editor が生成した .csproj と .sln を削除する
  3. プロジェクトを Unity Editor で開きなおす

マージ対象のプロジェクトと Unity が生成するソリューションで同名のプロジェクトが存在する場合、ProjectConflictResolution オプションを使用して3つの方法でコンフリクトを解決できます。

  • すべてのプロジェクトを維持
  • マージ対象のソリューションのプロジェクトを維持
  • Unity が生成したソリューションのプロジェクトを維持 (デフォルト)

ライセンス

MIT License

Copyright (c) 2019 Cysharp, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

This library includes code derived from the following open source libraries.

================================================================================
Microsoft.VisualStudio.SolutionPersistence
https://github.com/microsoft/vs-solutionpersistence
================================================================================
The MIT License (MIT)

Copyright (c) Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.