mirror of
https://github.com/Ed94/Cog.git
synced 2026-06-13 08:02:23 -07:00
Merge branch 'main' of https://github.com/arnaud-jamin/Cog
This commit is contained in:
Arnaud Jamin
@@ -1,9 +1,9 @@
|
||||
# Cog
|
||||
Cog is a set of debug tools for Unreal Engine built on top of [ImGui](https://github.com/ocornut/imgui)
|
||||
Cog is a set of debug tools for Unreal Engine built on top of [Dear ImGui](https://github.com/ocornut/imgui)
|
||||
|
||||
|
||||
|
||||
This [Video](https://www.youtube.com/watch?v=ea5hz3cFcMM) showcase various tools.
|
||||
This [Video](https://www.youtube.com/watch?v=ea5hz3cFcMM) showcase most of the tools in Cog.
|
||||
|
||||
- Cog provides:
|
||||
- ImGui windows to inspect and configure various Unreal features (Enhanced Inputs, Gameplay Abilities, Core Engine)
|
||||
@@ -35,7 +35,7 @@ Displays the state of Input Action.
|
||||
- The display input action are read from a Input Mapping Context defined in a Data Asset.
|
||||
|
||||
### Attributes
|
||||
Displays the gameplay attributes of the selected actor
|
||||
Displays the gameplay attributes of the selected actor.
|
||||
|
||||
|
||||
- Attributes can be sorted by name, category or attribute set.
|
||||
@@ -59,6 +59,7 @@ Used to inspect collisions by performing a collision query with the selected cha
|
||||
|
||||
- The query can be configured in the options.
|
||||
- The displayed collision channels can be configured in a Data Asset.
|
||||
- It can be used to better understand what object collisions are blocking a raycast.
|
||||
|
||||
### Debug Settings
|
||||
Used to tweak how the debug display is drawn.
|
||||
@@ -69,13 +70,13 @@ Used to tweak how the debug display is drawn.
|
||||
Displays the gameplay effects of the selected actor.
|
||||
|
||||
|
||||
- Mouse over an effect to see its details such as its modifiers, the gameplay tags it grants, the remaining time.
|
||||
- Mouse over an effect to see its details such as its modifiers, the gameplay tags it grants, the remaining time, etc.
|
||||
|
||||
### Gamepad
|
||||
Display the state of the gamepad
|
||||
|
||||
|
||||
- Can be used to inject inputs to help debugging.
|
||||
- Can be used to inject inputs to help debugging, as loosing window focus when breaking in the code doesn't affect the state of injected inputs unlike real inputs.
|
||||
|
||||
### Log Categories
|
||||
This window can be used to activate and deactivate log categories
|
||||
@@ -83,12 +84,12 @@ This window can be used to activate and deactivate log categories
|
||||
|
||||
- Activating a log category set its verbosity to VeryVerbose.
|
||||
- Deactivating a log category set its verbosity to Warning.
|
||||
- The detailed verbosity of each log category can shown by using the Option menu.
|
||||
- The detailed verbosity of each log category can be shown by using the Option menu.
|
||||
- A client can modify the verbosity of the server.
|
||||
- The log categories are used to display both output log and debug display in the world.
|
||||
- The log categories are used to filter both the output log and the debug draw.
|
||||
|
||||
### Metric
|
||||
This window gather values generated by the selected actor to compute how much output it produces or receives per second. This is typically useful to compute the damage dealt per second, the damage received per second, etc.
|
||||
This window gather various values sent by the selected actor and compte their rate per second. This is typically useful to compute the damage dealt or received per second.
|
||||
|
||||
|
||||
|
||||
@@ -145,7 +146,7 @@ Displays engine stats such as FPS, Ping, Packet Loss.
|
||||
|
||||
|
||||
### Tags
|
||||
Displays gameplay tags of the selected actor.
|
||||
Displays the gameplay tags of the selected actor.
|
||||
|
||||
|
||||
|
||||
@@ -153,7 +154,7 @@ Displays gameplay tags of the selected actor.
|
||||
Used to change the game global time scale.
|
||||
|
||||
|
||||
- If changed on a client the time scale is also modified on the game server.
|
||||
- If changed on a client the time scale is also modified on the game server, and reolicated to the other clients.
|
||||
|
||||
### Tweaks
|
||||
Used to apply tweaks to all the spawned actors
|
||||
@@ -168,7 +169,7 @@ Cog provides C++ and Blueprint functions to log and debug draw within Log Catego
|
||||
|
||||
|
||||
|
||||
Log and debug functions can be filtered to only what is outputted by the selected actor.
|
||||
Log and debug draw functions can be filtered by the selected actor.
|
||||
|
||||
|
||||
|
||||
@@ -193,11 +194,12 @@ The Cog repository has the following structure:
|
||||
- `CogSample` - A Sample that demonstrate various Cog functionalities. The project was saved in Unreal 5.1
|
||||
- `Plugins/CogAbility` - ImGui windows for the Gameplay Ability System (Abilities, Effects, Tags, ...)
|
||||
- `Plugins/CogInput` - ImGui windows for the Enhanced Input library (Input action, Gamepad)
|
||||
- `Plugins/CogEngine` - ImGui windows for the core unreal engine functionalities (Log, Stats, Time, Collisions, Skeleton, ...)
|
||||
- `Plugins/CogWindow` - ImGui window management (Base Window, Layout)
|
||||
- `Plugins/CogDebug` - Debug functionalities (Log, Debug Draw, Plot, Metric, ...)
|
||||
- `Plugins/CogImGui` - Integration of Imgui for Unreal, inspired by [UnrealImGui](https://github.com/segross/UnrealImGui)
|
||||
- `Plugins/CogCommon` - Common headers
|
||||
- `Plugins/Cog` - The main Cog plugin which contains the following modules
|
||||
- `CogEngine` - ImGui windows for the core unreal engine functionalities (Log, Stats, Time, Collisions, Skeleton, ...)
|
||||
- `CogWindow` - ImGui window management (Base Window, Layout)
|
||||
- `CogDebug` - Debug functionalities (Log, Debug Draw, Plot, Metric, ...)
|
||||
- `CogImGui` - Integration of Imgui for Unreal, inspired by [UnrealImGui](https://github.com/segross/UnrealImGui)
|
||||
- `CogCommon` - Interfaces implemented by your project actor classes which cannot be excluded from a shipping build
|
||||
|
||||
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.
|
||||
|
||||
@@ -303,13 +305,6 @@ void ACogSampleGameState::BeginPlay()
|
||||
```
|
||||
|
||||
|
||||
- Define which key will toggle the input from the game to Imgui:
|
||||
```cpp
|
||||
// ACogSampleGameState.cpp
|
||||
FCogImguiModule::Get().SetToggleInputKey(FCogImGuiKeyInfo(EKeys::Insert));
|
||||
```
|
||||
|
||||
|
||||
- Tick the CogWindowManager:
|
||||
```cpp
|
||||
// ACogSampleGameState.cpp
|
||||
|
||||
Reference in New Issue
Block a user