RiderSourceCodeAccess 插件使用教程

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

RiderSourceCodeAccess 是一个为 Unreal Engine 提供的插件，允许用户在 Unreal Editor 中选择 "Rider for Unreal Engine" 作为源代码编辑器。以下是该项目的目录结构及主要文件介绍：

RiderSourceCodeAccess/
├── Source/
│   └── RiderSourceCodeAccess/
│       ├── Private/
│       │   └── RiderSourceCodeAccessModule.cpp
│       ├── Public/
│       │   └── RiderSourceCodeAccessModule.h
│       └── RiderSourceCodeAccess.Build.cs
├── Resources/
│   └── Icon128.png
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── README.md
└── RiderSourceCodeAccess.uplugin

• Source/: 包含插件的主要源代码。
  • RiderSourceCodeAccess/: 插件的核心代码目录。
    • Private/: 包含私有实现文件，如 RiderSourceCodeAccessModule.cpp。
    • Public/: 包含公共头文件，如 RiderSourceCodeAccessModule.h。
    • RiderSourceCodeAccess.Build.cs: 插件的构建配置文件。
• Resources/: 包含插件的资源文件，如图标。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• LICENSE.txt: 许可证文件。
• README.md: 项目说明文件。
• RiderSourceCodeAccess.uplugin: 插件描述文件。

2. 项目的启动文件介绍

RiderSourceCodeAccess 插件的启动文件主要是 RiderSourceCodeAccess.uplugin 文件。该文件是一个 JSON 格式的配置文件，用于描述插件的基本信息和依赖关系。

{
  "FileVersion": 3,
  "Version": "1.0",
  "VersionName": "1.0",
  "FriendlyName": "RiderSourceCodeAccess",
  "Description": "Plugin for UE4 to use Rider for Unreal Engine as code editor",
  "Category": "Editor",
  "CreatedBy": "JetBrains",
  "CreatedByURL": "https://www.jetbrains.com",
  "DocsURL": "",
  "MarketplaceURL": "",
  "SupportURL": "",
  "CanContainContent": false,
  "IsBetaVersion": false,
  "Installed": false,
  "Modules": [
    {
      "Name": "RiderSourceCodeAccess",
      "Type": "Editor",
      "LoadingPhase": "Default",
      "WhitelistPlatforms": [
        "Win64",
        "Mac",
        "Linux"
      ]
    }
  ]
}

3. 项目的配置文件介绍

RiderSourceCodeAccess 插件的配置文件主要是 RiderSourceCodeAccess.Build.cs 文件。该文件是一个 C# 脚本，用于定义插件的构建配置。

using UnrealBuildTool;

public class RiderSourceCodeAccess : ModuleRules
{
    public RiderSourceCodeAccess(ReadOnlyTargetRules Target) : base(Target)
    {
        PrivateDependencyModuleNames.AddRange(
            new string[]
            {
                "Core",
                "CoreUObject",
                "Engine",
                "InputCore",
                "UnrealEd",
                "EditorStyle",
                "Slate",
                "SlateCore",
                "SourceControl",
                "DesktopPlatform",
                "Projects"
            }
        );
    }
}

该文件定义了插件依赖的模块，确保插件在构建时能够正确链接所需的库和模块。

---

以上是 RiderSourceCodeAccess 插件的基本使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该插件。