ed/Cog
1
0
Fork 0
mirror of https://github.com/Ed94/Cog.git synced 2026-06-17 09:52:23 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/arnaud-jamin/Cog

Browse Source
This commit is contained in:
Arnaud Jamin
2023-10-09 19:09:33 -04:00
parent 02a11e8b7c 39af2d17b1
commit 9ec695e65b
1 changed files with 40 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+40 -8
View File
@@ -5,7 +5,7 @@ Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com
## Project Structure
- `CogSample` - A Sample that demonstrate various Cog functionalities
- `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, ...)
@@ -16,26 +16,56 @@ Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com
## 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.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/5eece87c-eba3-45f1-95c5-e132be2133b8)
- 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
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/6323e78b-2ee4-43e2-bec6-19aa15716d2c)
### Attributes
Displays the gameplay attributes of the selected actor
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/a6329ef1-f775-4e6e-9581-6389f9f4b39c)
- 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.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/b7b89635-7924-49b7-98c0-311199947dfc)
- 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.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/ccee855b-b33b-4dfc-ba14-dff87e1150cf)
- The query can be configured in the options.
- The displayed collision channels can be configured in a Data Asset.
### Debug Settings
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e55c8d07-133e-48ab-a974-ed076f3d4a58)
### Effects
Displays the gameplay effects of the selected actor.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/4fffa8fe-bd93-44bc-8ca5-27ae81f5da0c)
- Mouse over an effect to see its details such as its modifiers, the gameplay tags it grants, the remaining time.
### Gamepad
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/734dd08a-5b9f-44cf-8d24-9bf257f08ec6)
@@ -53,7 +83,10 @@ Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/71b1de06-a3d0-4e4d-83f3-c3f482c0d8f4)
### Pools
Displays attributes of the selected actor as pools.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/7bb1aadd-9c0b-439f-b263-5ed842d0cd69)
- The pools can be configured in a data asset.
### Plots
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/bc134e95-4887-4245-b34d-c030464f644a)
@@ -74,17 +107,16 @@ Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e394ec7b-02fa-4b09-879b-90c82bd542ef)
### Tags
Displays gameplay tags of the selected actor.
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/3f14be3f-77f2-4d59-887d-1245fc97ed6a)
### Time Scale
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/d19198c5-37dd-400d-a09f-7a5077eb2511)
### Tweaks
Used to apply tweaks to all the spawned actors
![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e8a5cdd5-908d-4ae3-901a-48addd4ce353)
- The tweaks are used to test various gameplay settings by actor category
- The tweaks can be configured in a data asset.