VSCUnity 开源项目教程

VSCUnity 开源项目教程

VSCUnityUnity3D editor plugin to make Unity projects Visual Studio Code compatible.项目地址:https://gitcode.com/gh_mirrors/vs/VSCUnity

1. 项目的目录结构及介绍

VSCUnity 项目的目录结构如下：

VSCUnity/
├── Assets/
│   ├── Editor/
│   │   └── VSCSettings.cs
│   ├── Plugins/
│   │   └── VisualStudioCode/
│   │       └── Editor/
│   │           ├── VSCSettings.cs
│   │           └── VSCSettingsProvider.cs
│   ├── Resources/
│   │   └── VSCSettings.asset
│   └── Scripts/
│       └── ExampleScript.cs
├── Packages/
│   └── manifest.json
├── ProjectSettings/
│   └── VSCSettings.asset
├── README.md
└── .gitignore

目录结构介绍

• Assets/: 包含项目的主要资源文件，如脚本、编辑器扩展、插件等。
  • Editor/: 包含编辑器扩展脚本，用于自定义 Unity 编辑器的行为。
  • Plugins/: 包含第三方插件，如 VisualStudioCode 插件。
  • Resources/: 包含资源文件，如预设、材质等。
  • Scripts/: 包含项目的脚本文件。
• Packages/: 包含项目的包管理文件，如 manifest.json。
• ProjectSettings/: 包含项目的设置文件，如 VSCSettings.asset。
• README.md: 项目的说明文档。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件主要是 Assets/Editor/VSCSettings.cs 和 Assets/Plugins/VisualStudioCode/Editor/VSCSettingsProvider.cs。

VSCSettings.cs

该文件定义了 VSCUnity 的设置类，包含了一些基本的配置选项，如 Visual Studio Code 的路径等。

using UnityEngine;
using UnityEditor;

public class VSCSettings : ScriptableObject
{
    public string vscodePath = "";
}

VSCSettingsProvider.cs

该文件定义了 VSCUnity 的设置提供者，用于在 Unity 编辑器中创建一个自定义的设置界面。

using UnityEngine;
using UnityEditor;
using UnityEditor.SettingsManagement;

public static class VSCSettingsProvider
{
    [SettingsProvider]
    public static SettingsProvider CreateVSCSettingsProvider()
    {
        var provider = new SettingsProvider("Preferences/VSCUnity", SettingsScope.User)
        {
            label = "VSCUnity",
            guiHandler = (searchContext) =>
            {
                var settings = VSCSettings.GetOrCreateSettings();
                settings.vscodePath = EditorGUILayout.TextField("Visual Studio Code Path", settings.vscodePath);
                if (GUILayout.Button("Save"))
                {
                    EditorUtility.SetDirty(settings);
                    AssetDatabase.SaveAssets();
                }
            }
        };
        return provider;
    }
}

3. 项目的配置文件介绍

项目的配置文件主要是 ProjectSettings/VSCSettings.asset 和 Assets/Resources/VSCSettings.asset。

VSCSettings.asset

该文件是 VSCUnity 的配置文件，包含了 Visual Studio Code 的路径等配置信息。

%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
--- !u!114 &11400000
MonoBehaviour:
  m_ObjectHideFlags: 0
  m_CorrespondingSourceObject: {fileID: 0}
  m_PrefabInstance: {fileID: 0}
  m_PrefabAsset: {fileID: 0}
  m_GameObject: {fileID: 0}
  m_Enabled: 1
  m_EditorHideFlags: 0
  m_Script: {fileID: 12345, guid: 12345, type: 3}
  m_Name: VSCSettings
  m_EditorClassIdentifier: 
  vscodePath: "C:/Program Files/Microsoft VS Code/Code.exe"

通过以上配置文件，可以自定义 Visual Studio Code 的路径，以便在 Unity

VSCUnityUnity3D editor plugin to make Unity projects Visual Studio Code compatible.项目地址:https://gitcode.com/gh_mirrors/vs/VSCUnity