diff --git a/README.md b/README.md index 96e8159..11ab7d6 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,11 @@ Cog is a set of debug tools for Unreal Engine built on top of [ImGui](https://gi ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/21659aea-2cd8-4ef6-b3b0-5795f5f3246b) -- Cog provides specific ImGui windows to inspect and configure various Unreal features (Enhanced Inputs, Gameplay Abilities, Core Engine) -- Cog provides a window mangement with persistent configuration and layouts. -- Cog provides C++ and Blueprint functions to log and debug draw within Log Categories. -- Cog provides some control over the server (spawning, debug draw, logging) +- Cog provides: + - ImGui windows to inspect and configure various Unreal features (Enhanced Inputs, Gameplay Abilities, Core Engine) + - Window mangement with persistent configuration and layouts. + - C++ and Blueprint functions to log and debug draw within Log Categories. + - Control over the server regarding debug draw, logging, spawning, cheats. ## Windows @@ -198,7 +199,6 @@ The Cog repository has the following structure: Cog has multiple plugins to ease the integration for projects that do not use the `Ability System Component` or `Enhanced Input`. For the next steps, it is assumed all the plugins are used. - - Setup up module dependencies: ```c# // CogSample.Build.cs @@ -286,7 +286,7 @@ void ACogSampleGameState::BeginPlay() CogWindowManager->CreateWindow("Engine.Debug Settings"); CogWindowManager->CreateWindow("Engine.ImGui"); - // Add windows that uses a data asset. The data asset must be created inside Unreal Editor. + // Add windows that uses a data asset. The data asset must be created inside Unreal Editor. const UCogAbilityDataAsset* AbilitiesAsset = GetFirstAssetByClass(); UCogAbilityWindow_Abilities* AbilitiesWindow = CogWindowManager->CreateWindow("Gameplay.Abilities"); @@ -327,11 +327,10 @@ void ACogSampleGameState::Tick(float DeltaSeconds) // CogSampleCharacter.h UCLASS(config=Game) class ACogSampleCharacter : public ACharacter - , public IAbilitySystemInterface + [...] , public ICogCommonDebugFilteredActorInterface , public ICogCommonAllegianceActorInterface - , public ICogSampleTeamInterface - , public ICogSampleTargetableInterface + [...] ``` ```cpp @@ -342,5 +341,11 @@ class ACogSamplePlayerController , public ICogCommonPossessorInterface ``` -__ -- In Unreal Editor create and configure the Data Assets +- In Unreal Editor create and configure the following Data Assets: + - CogAbilityDataAsset + - CogEngineDataAsset + - CogInputDataAsset + + + +