From d928075ff10aaae5281d5f79851f02b9356ad579 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Mon, 2 Oct 2023 11:44:21 -0400 Subject: [PATCH] Update README.md --- README.md | 62 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8b1feba..ff4104c 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,85 @@ # Cog -Cog are debug tools for Unreal Engine built on top of ImGui +Cog are debug tools for Unreal Engine built on top of [ImGui](https://github.com/ocornut/imgui) -## Engine Tools +## Project Structure -### Collisions +- `Plugins/CogImGui` - A simple wrapper of Imgui for Unreal, inspired by [UnrealImGui](https://github.com/segross/UnrealImGui) +- `Plugins/CogDebug` - Debug functionalities +- `Plugins/CogWindow` - Debug Window management +- `Plugins/CogEngine` - Debug Windows for the core unreal engine functionalities (Log, Stats, Time, Collisions, Skeleton, ...) +- `Plugins/CogInput` - Debug Windows using the Enhanced Input library (Input action, Gamepad) +- `Plugins/CogAbility` - Debug Windows interacting with the Gameplay Ability System (Gameplay Abilities, Gameplay Effects, Gameplay Tags, ...) +- `CogSample` - A Sample that demonstrate Cog + +## Windows + +### Engine Windows + +#### Collisions ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/ccee855b-b33b-4dfc-ba14-dff87e1150cf) -### Debug Settings +#### Debug Settings ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e55c8d07-133e-48ab-a974-ed076f3d4a58) -### Log Categories +#### Log Categories ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/7ced2751-c3bc-43a3-9280-d11a34bf0482) -### Net Emulation +#### Net Emulation ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/97103f15-fae8-4fe9-8189-8fdbcab5cb20) -### Output Log +#### Output Log ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/71b1de06-a3d0-4e4d-83f3-c3f482c0d8f4) -### Plots +#### Plots ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/bc134e95-4887-4245-b34d-c030464f644a) -### Scalability +#### Scalability ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/4866b54c-5efa-4efa-a841-74ac8e1713c0) -### Skeleton +#### Skeleton ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/19648e3d-70dc-45bc-940d-e53eb9a99871) -### Selection +#### Selection ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/67cf9019-85c0-449f-88bf-0fc4841f8795) -### Stats +#### Stats ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e394ec7b-02fa-4b09-879b-90c82bd542ef) -### Time +#### Time ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/d19198c5-37dd-400d-a09f-7a5077eb2511) -## Gameplay Ability Tools +### Gameplay Ability Windows -### Abilities +#### Abilities ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/5eece87c-eba3-45f1-95c5-e132be2133b8) -### Attributes +#### Attributes ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/a6329ef1-f775-4e6e-9581-6389f9f4b39c) -### Cheats +#### Cheats ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/b7b89635-7924-49b7-98c0-311199947dfc) -### Damages +#### Damages ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/64d3cb7c-8731-4897-9ef9-b0868148ebe2) -### Effects +#### Effects ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/4fffa8fe-bd93-44bc-8ca5-27ae81f5da0c) -### Pools +#### Pools ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/7bb1aadd-9c0b-439f-b263-5ed842d0cd69) -### Tags +#### Tags ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/3f14be3f-77f2-4d59-887d-1245fc97ed6a) -### Tweaks +#### Tweaks ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/e8a5cdd5-908d-4ae3-901a-48addd4ce353) -## Input Tools +### Input Windows -### Input Actions +#### Input Actions ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/6323e78b-2ee4-43e2-bec6-19aa15716d2c) -### Gamepad +#### Gamepad ![image](https://github.com/arnaud-jamin/Cog/assets/13844285/734dd08a-5b9f-44cf-8d24-9bf257f08ec6)