mirror of
https://github.com/Ed94/Cog.git
synced 2026-06-25 21:25:02 -07:00
Arnaud Jamin
115 lines
5.4 KiB
Markdown
115 lines
5.4 KiB
Markdown
# Cog
|
|
Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com/ocornut/imgui)
|
|
|
|
|
|
|
|
## Project Structure
|
|
|
|
- `CogSample` - A Sample that demonstrate various Cog functionalities
|
|
- `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/CogInterface` - Interfaces implemented by actors to inspect them
|
|
|
|
## ImGui Windows
|
|
|
|
- Most windows display their contents based on a selected actor.
|
|
- The selector actor can be chosen using the selection window or widget.
|
|
- mouse over a window title to display its help. This behavior can be disabled in the Window menu.
|
|
- Window Layouts can be saved/loaded.
|
|
- Windows save their own settings in a Cog.ini file to maintain their state between multiple sessions.
|
|
|
|
### Abilities
|
|
Displays the gameplay abilities of the selected actor.
|
|
|
|
- Click the ability checkbox to force its activation or deactivation.
|
|
- Right click an ability to open or close the ability separate window.
|
|
- Use the 'Give Ability' menu to manually give an ability from a list defined in a data asset.
|
|
|
|
### Actions
|
|
|
|
|
|
### Attributes
|
|
Displays the gameplay attributes of the selected actor
|
|
|
|
- Attributes can be sorted by name, category or attribute set.
|
|
- Attributes with the Current value greater than the Base value are displayed in green.
|
|
- Attributes with the Current value lower than the Base value are displayed in red. - Use the options 'Show Only Modified' to only show the attributes that have modifiers.
|
|
|
|
### Cheats
|
|
Used to apply cheats to the selected actor.
|
|
|
|
- The cheats are gameplay effects configured in a data asset.
|
|
- Key modifiers can be used to change which actor should be affected by the cheat:
|
|
- [CTRL] apply the cheat to the controlled actor
|
|
- [ALT] apply the cheat to the allies of the selected actor
|
|
- [SHIFT] apply the cheat to the enemies of the selected actor
|
|
|
|
### Collisions
|
|
Used to inspect collisions by performing a collision query with the selected channels.
|
|
|
|
- The query can be configured in the options.
|
|
- The displayed collision channels can be configured in a Data Asset.
|
|
|
|
### Debug Settings
|
|
|
|
|
|
### Effects
|
|
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.
|
|
|
|
### Gamepad
|
|
|
|
|
|
### Log Categories
|
|
|
|
|
|
### Metric
|
|
|
|
|
|
### Net Emulation
|
|
|
|
|
|
### Output Log
|
|
|
|
|
|
### Pools
|
|
Displays attributes of the selected actor as pools.
|
|
|
|
- The pools can be configured in a data asset.
|
|
|
|
### Plots
|
|
|
|
|
|
### Scalability
|
|
|
|
|
|
### Skeleton
|
|
|
|
|
|
### Selection
|
|
|
|
|
|
### Spawn
|
|
|
|
|
|
### Stats
|
|
|
|
|
|
### Tags
|
|
Displays gameplay tags of the selected actor.
|
|
|
|
|
|
### Time Scale
|
|
|
|
|
|
### Tweaks
|
|
Used to apply tweaks to all the spawned actors
|
|
|
|
- The tweaks are used to test various gameplay settings by actor category
|
|
- The tweaks can be configured in a data asset.
|