ue-project-context
Use when creating, refreshing or repairing `.agents/ue-project-context.md`, the project document every other UE skill reads first. Also use when the user says 'project context', 'set up context', 'UE context', 'scan my project', 'onboard the agent to my project', 'update project context', 'configure project', 'what engine version is this project on', 'which plugins do we have enabled', or complains that UE advice keeps coming out generic. For Build.cs and Target.cs mechanics, see ue-module-build-system; for naming and API-macro conventions, see ue-cpp-foundations; for GAS specifics, see ue-gameplay-abilities.
quodsoler · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add quodsoler/unreal-engine-skills --skill ue-project-context技能说明
name: ue-project-context
description: "Use when creating, refreshing or repairing .agents/ue-project-context.md, the project document every other UE skill reads first. Also use when the user says 'project context', 'set up context', 'UE context', 'scan my project', 'onboard the agent to my project', 'update project context', 'configure project', 'what engine version is this project on', 'which plugins do we have enabled', or complains that UE advice keeps coming out generic. For Build.cs and Target.cs mechanics, see ue-module-build-system; for naming and API-macro conventions, see ue-cpp-foundations; for GAS specifics, see ue-gameplay-abilities."
metadata:
version: "2.0.0"
engine: "5.8"
UE Project Context
Target engine: UE 5.8. APIs below are verified against the 5.8 headers; older forms are listed under "Deprecated — do not use".
This skill produces and maintains .agents/ue-project-context.md — the single file the other UE skills read to learn the project's engine version, module layout, enabled plugins, coding conventions, gameplay framework classes, networking model and build targets. It reads project files only (.uproject, *.Build.cs, *.Target.cs, Config/Default*.ini, Plugins/*/*.uplugin); it calls no engine API. This is the one skill in this set that is deliberately a conversation: every line it writes must come from the codebase or from the user, never from a guess.
Context
Read .agents/ue-project-context.md if it exists (module names, conventions, enabled plugins, GAS/networking setup). Do not stop if it is missing — this skill is what creates it.
The default path is scan first, then interview. Build a draft from the codebase before asking anything, then let the user correct it. Do not open with a menu of options.
| Request is about… | Go to |
|---|---|
| First-time setup, or the file is missing | Step 1: Scan and draft |
| What to read and what to pull out of each file | What to scan |
| Naming a plugin the project has enabled | Plugin checklist |
| Reviewing the draft with the user | Step 2: Correct the draft |
| Saving or refreshing an existing context file | Step 3: Save and confirm |
| No C++ source to scan (Blueprint-only, or a new empty project) | Fallback questionnaire |
| The shape of the output file | Document template |
Step 1: Scan and draft
- Check whether
.agents/ue-project-context.mdexists. If it does, read it and treat it as the previous draft rather than starting over. - Scan the files in What to scan. Fill every field you can prove from a file.
- Mark anything the files cannot answer as
[unknown]in the draft. Never invent a team size, a coding rule or a networking model. - Present the whole draft in one message, then move to Step 2.
A partial scan is still worth presenting. Engine version, module list and plugin list come out of the files almost entirely, which removes most of the interview.
What to scan
| File | Pull out |
|---|---|
*.uproject | EngineAssociation (e.g. "EngineAssociation": "5.8"; a GUID means a registered source build; empty means a native project inside an engine tree), Modules[] (Name, Type, LoadingPhase), Plugins[] (Name, Enabled), TargetPlatforms[] |
Source/*/*.Build.cs | Module class name, PublicDependencyModuleNames, PrivateDependencyModuleNames, PublicIncludePathModuleNames, third-party include/library paths, any PublicDefinitions |
Source/*.Target.cs | Type (TargetType.Game, Editor, Client, Server, Program), ExtraModuleNames, DefaultBuildSettings, IncludeOrderVersion, platform conditionals |
Config/DefaultEngine.ini | [/Script/EngineSettings.GameMapsSettings] — GameDefaultMap, ServerDefaultMap, GlobalDefaultGameMode, GameInstanceClass (the module is EngineSettings, not Engine); [/Script/Engine.RendererSettings] for the rendering feature set |
Config/DefaultGame.ini | Project display name and version; [/Script/Engine.AssetManagerSettings] — PrimaryAssetTypesToScan, which reveals the data-driven asset layout |
Config/DefaultInput.ini | [/Script/Engine.InputSettings] — DefaultPlayerInputClass / DefaultInputComponentClass (/Script/EnhancedInput.EnhancedPlayerInput / EnhancedInputComponent means Enhanced Input is live; InputSettings.h:219,223), leftover legacy ActionMappings/AxisMappings; [/Script/EnhancedInput.EnhancedInputDeveloperSettings] for Enhanced Input project settings |
Config/DefaultGameplayTags.ini | [/Script/GameplayTags.GameplayTagsSettings] — GameplayTagList, GameplayTagTableList, ImportTagsFromConfig |
Plugins/*/*.uplugin | In-house plugin names, their Modules[] and their Plugins[] dependencies |
Source/*/Public/** (spot-check 3–5 headers) | Naming prefixes in practice, TObjectPtr versus raw pointers, API macro style (MYGAME_API on each declaration, or a per-header #define UE_API MYGAME_API), DEFINE_LOG_CATEGORY names, check/ensure usage |
Also grep Config/Default*.ini for every other [/Script/...] section the project has customised — those sections name the systems the team actually configures.
Plugin checklist
Cross-check Plugins[] in the .uproject against this list and record maturity wherever it changes the advice other skills give. These are .uplugin names in 5.8.
| Area | Plugins to look for |
|---|---|
| Abilities & modularity | GameplayAbilities, GameFeatures (Beta), ModularGameplay (Beta), SmartObjects, InstancedActors (Experimental) |
| Input | EnhancedInput |
| UI | CommonUI, ModelViewViewModel (Beta) |
| AI & simulation | StateTree, GameplayStateTree, MassGameplay (Experimental), MassAI (Experimental) |
| Animation & movement | Mover (Experimental), |