From 299e90451b994ee060fa5025632260d3e57d4336 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:07:16 -0500 Subject: [PATCH 01/12] Update README.md --- README.md | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 27815ce..8c4d8e2 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ General Info: Displays the gameplay abilities of the selected actor. -[![Abilities](https://github.com/arnaud-jamin/Cog/assets/13844285/cc6cb2af-eb9a-42fd-8ae5-80b5c7b361e9)]() +![Abilities](https://github.com/user-attachments/assets/b332cf3a-9fee-408f-a86e-157c513c0ee2) - Click the ability checkbox to force its activation or deactivation. - Right click an ability to remove it, or open/close the ability separate window. - Use the 'Give Ability' menu to manually give an ability from a list defined in a Data Asset. @@ -33,14 +33,14 @@ Displays the gameplay abilities of the selected actor. ### Actions Displays the state of Input Action. -![Actions](https://github.com/arnaud-jamin/Cog/assets/13844285/6323e78b-2ee4-43e2-bec6-19aa15716d2c) +![Actions](https://github.com/user-attachments/assets/e4b60f69-efa0-4a23-b78e-9f261e5f78f5) - 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. - 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. -![Attributes](https://github.com/arnaud-jamin/Cog/assets/13844285/a6329ef1-f775-4e6e-9581-6389f9f4b39c) +![Attributes](https://github.com/user-attachments/assets/ff010ac5-d8e5-44ca-b46f-263c45a0fc47) - 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. @@ -89,6 +89,17 @@ Used to configure the command bindings. - `Cog.LoadLayout ` - `Cog.ToggleSelectionMode` +### Console +Used as a replacement of the Unreal console command. + +![Console](https://github.com/user-attachments/assets/224b8913-61fb-4a63-b63a-fc3522fafe5f) +- The console exist as a window and a widget (placed in main menu bar). +- The console widget can optionaly get the keyboard focus when the main menu bar is shown. +- Use the Keys Up/Down or Tab/Shift-Tab to nagivate in the command list. +- The console settings can be change in the console window menu, or by right clicking the widget. + +![Console Settings](https://github.com/user-attachments/assets/92bd2e0e-e860-403d-ade3-e780fb3a88c7) + ### Debug Settings Used to tweak how the debug display is drawn. @@ -149,6 +160,15 @@ The following image shows the editor running along a dedicated server. The NetIm This can be used to debug the state of the game server. For example the behavior trees are only available on the game server. ![image](https://github.com/user-attachments/assets/3cd788c9-9884-4c1c-8333-7a311bdcd20a) +### Notifications +Use to display and configure notifications + +![Notification](https://github.com/user-attachments/assets/84db0359-f002-4c35-9d45-11187b3f9228) + +- Notification can be added by calling COG_NOTIFY, COG_NOTIFY_WARNING, COG_NOTIFY_ERROR. +- Notification settings can used to adjust the filtering, their location, their size, etc. +![Notification Settings](https://github.com/user-attachments/assets/aa47495e-4544-4e33-925e-d87cb9125e76) + ### Output Log Display the output log based on each log categories verbosity. @@ -185,15 +205,7 @@ Plots values and events overtime. When applicable, only the values and events of Used to configure the rendering quality. ![Scalability](https://github.com/arnaud-jamin/Cog/assets/13844285/4866b54c-5efa-4efa-a841-74ac8e1713c0) - -### Skeleton -Display the bone hierarchy and the skeleton debug draw of the selected actor if it has a Skeletal Mesh. - -![Skeleton](https://github.com/arnaud-jamin/Cog/assets/13844285/19648e3d-70dc-45bc-940d-e53eb9a99871) -- Mouse over a bone to highlight it. -- Right click a bone to access more debug display. -- Use the [Ctrl] key to toggle the bone debug draw recursively. - + ### Selection Used to select an actor either by picking an actor in the world or by selecting an actor in the actor list. @@ -208,6 +220,14 @@ Configure the settings of Cog Windows. - Can configure the input key to toggle the input focus between the game and imgui - Can change the DPI Scaling +### Skeleton +Display the bone hierarchy and the skeleton debug draw of the selected actor if it has a Skeletal Mesh. + +![Skeleton](https://github.com/arnaud-jamin/Cog/assets/13844285/19648e3d-70dc-45bc-940d-e53eb9a99871) +- Mouse over a bone to highlight it. +- Right click a bone to access more debug display. +- Use the [Ctrl] key to toggle the bone debug draw recursively. + ### Spawn Used to spawn new actors in the world. The spawn list can be configured in a Data Asset. From 1f5479ae2b2a7eb91ac5f7db8d3ddfc112898e6e Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:16:29 -0500 Subject: [PATCH 02/12] Update README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c4d8e2..075d769 100644 --- a/README.md +++ b/README.md @@ -59,12 +59,15 @@ Displays the blackboard of the selected actor. ### Cheats Used to apply cheats to the selected actor. -![Cheats](https://github.com/arnaud-jamin/Cog/assets/13844285/b7b89635-7924-49b7-98c0-311199947dfc) -- The cheats are gameplay effects configured in a data asset. +![Cheats](https://github.com/user-attachments/assets/e3bbf157-904f-40e9-a0bf-e8152ff24af4) +- Cheats replicated to the game server to be executed. - 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 +- Cheats can be defined in a Data Asset. Cog provide two default cheat execution (Apply Effect, Activate Ability). +- Cheat executions can be defined in blueprint. +![Cheats Asset](https://github.com/user-attachments/assets/46a14b89-ebab-4628-b97b-e5ccd2b63576) ### Collisions Tester Used to test a collision query From 65eb0190088b3f3e519b656370f3086b0384aeae Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:17:02 -0500 Subject: [PATCH 03/12] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 075d769..443f78a 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ Used to apply cheats to the selected actor. - `[SHIFT]` Apply the cheat to the enemies of the selected actor - Cheats can be defined in a Data Asset. Cog provide two default cheat execution (Apply Effect, Activate Ability). - Cheat executions can be defined in blueprint. + ![Cheats Asset](https://github.com/user-attachments/assets/46a14b89-ebab-4628-b97b-e5ccd2b63576) ### Collisions Tester From e15ebc57e676fa563ab2e20b20a5011737fbde05 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:22:25 -0500 Subject: [PATCH 04/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 443f78a..97b87f6 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ Used to tweak how the debug display is drawn. ### Effects Displays the gameplay effects of the selected actor. -![Effects](https://github.com/arnaud-jamin/Cog/assets/13844285/4fffa8fe-bd93-44bc-8ca5-27ae81f5da0c) +![Effects](https://github.com/user-attachments/assets/ff9c0baa-80d8-4916-a81a-9914443bd88b) - Mouse over an effect to see its details such as its modifiers, the gameplay tags it grants, the remaining time, etc. ### Gamepad From e07816b925d35b1d3c708269a37bc1515493f1ed Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:24:08 -0500 Subject: [PATCH 05/12] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97b87f6..4820f8a 100644 --- a/README.md +++ b/README.md @@ -169,8 +169,9 @@ Use to display and configure notifications ![Notification](https://github.com/user-attachments/assets/84db0359-f002-4c35-9d45-11187b3f9228) -- Notification can be added by calling COG_NOTIFY, COG_NOTIFY_WARNING, COG_NOTIFY_ERROR. +- Notification can be added by using the following macros: `COG_NOTIFY`, `COG_NOTIFY_WARNING`, or `COG_NOTIFY_ERROR`. - Notification settings can used to adjust the filtering, their location, their size, etc. + ![Notification Settings](https://github.com/user-attachments/assets/aa47495e-4544-4e33-925e-d87cb9125e76) ### Output Log From e99af1bb22a85e04286d68b2621e28e931ac707d Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:32:43 -0500 Subject: [PATCH 06/12] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4820f8a..8248dc9 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,15 @@ Displays the blackboard of the selected actor. Used to apply cheats to the selected actor. ![Cheats](https://github.com/user-attachments/assets/e3bbf157-904f-40e9-a0bf-e8152ff24af4) -- Cheats replicated to the game server to be executed. +- Cheats are replicated to the game server to be executed. - 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 +- Optionaly, cheats applied to the local player character are automatically reapplied. + +![Cheats Settings](https://github.com/user-attachments/assets/006c4cf0-34e2-4e0d-8be7-be27db8796aa) + - Cheats can be defined in a Data Asset. Cog provide two default cheat execution (Apply Effect, Activate Ability). - Cheat executions can be defined in blueprint. From d14a129e3b70ff1f80da1a5e5c7600dff2942489 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:41:22 -0500 Subject: [PATCH 07/12] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8248dc9..c43f7fa 100644 --- a/README.md +++ b/README.md @@ -245,7 +245,12 @@ Used to spawn new actors in the world. The spawn list can be configured in a Dat ### Stats Displays engine stats such as FPS, Ping, Packet Loss. -![Stats](https://github.com/arnaud-jamin/Cog/assets/13844285/e394ec7b-02fa-4b09-879b-90c82bd542ef) +![Stats](https://github.com/user-attachments/assets/424bac6a-76df-4d69-9d34-445a4a4bf536) + +- Stats can be viewed as a widget in the main menu bar. Clicking on the stat povide menu to force the stat to a specific value. +- Right cliking on the stat display the settings, where the specific stat values can be defined. + +![Stats Settings](https://github.com/user-attachments/assets/a3545a8f-e742-4e8e-8758-03af133d932e) ### Tags Displays the gameplay tags of the selected actor. From f9e94ed4c4c63affd5e49f136bbe0f564d008fd3 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:42:27 -0500 Subject: [PATCH 08/12] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c43f7fa..e36e74e 100644 --- a/README.md +++ b/README.md @@ -247,7 +247,8 @@ Displays engine stats such as FPS, Ping, Packet Loss. ![Stats](https://github.com/user-attachments/assets/424bac6a-76df-4d69-9d34-445a4a4bf536) -- Stats can be viewed as a widget in the main menu bar. Clicking on the stat povide menu to force the stat to a specific value. +- Stats can be viewed as a widget in the main menu bar. +- Clicking on the stat povide a menu to force the stat to a reach a specific value. - Right cliking on the stat display the settings, where the specific stat values can be defined. ![Stats Settings](https://github.com/user-attachments/assets/a3545a8f-e742-4e8e-8758-03af133d932e) From 0081103e4dd939117c13e3b761def55a8e207f77 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:45:40 -0500 Subject: [PATCH 09/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e36e74e..49e8b3e 100644 --- a/README.md +++ b/README.md @@ -256,7 +256,7 @@ Displays engine stats such as FPS, Ping, Packet Loss. ### Tags Displays the gameplay tags of the selected actor. -![Tags](https://github.com/arnaud-jamin/Cog/assets/13844285/3f14be3f-77f2-4d59-887d-1245fc97ed6a) +![Tags](https://github.com/user-attachments/assets/9aef871c-5af0-4ee0-8eb8-5fd706b43e51) ### Time Scale Used to change the game global time scale. From eef01f5ca6cad64dcb060b155dee1d038f441696 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:48:14 -0500 Subject: [PATCH 10/12] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49e8b3e..801dfc4 100644 --- a/README.md +++ b/README.md @@ -249,7 +249,7 @@ Displays engine stats such as FPS, Ping, Packet Loss. - Stats can be viewed as a widget in the main menu bar. - Clicking on the stat povide a menu to force the stat to a reach a specific value. -- Right cliking on the stat display the settings, where the specific stat values can be defined. +- Right cliking the stat display the settings, where the specific stat values can be defined. ![Stats Settings](https://github.com/user-attachments/assets/a3545a8f-e742-4e8e-8758-03af133d932e) @@ -263,6 +263,9 @@ Used to change the game global time scale. ![Time Scale](https://github.com/arnaud-jamin/Cog/assets/13844285/d19198c5-37dd-400d-a09f-7a5077eb2511) - If changed on a client the time scale is also modified on the game server, and replicated to the other clients. +- Time Scale can be viewed as a widget in the main menu bar. +- Right cliking the Time Scale display the settings, where the specific Time Scale values can be defined. +![image](https://github.com/user-attachments/assets/130f6250-af5b-41fb-8ae2-016c66fbdedc) ### Transform Used to read and set the selected actor transform. From f5b20cc8989471775367e70a99e997b94f1ed4bb Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:48:41 -0500 Subject: [PATCH 11/12] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 801dfc4..3fb649b 100644 --- a/README.md +++ b/README.md @@ -265,6 +265,7 @@ Used to change the game global time scale. - If changed on a client the time scale is also modified on the game server, and replicated to the other clients. - Time Scale can be viewed as a widget in the main menu bar. - Right cliking the Time Scale display the settings, where the specific Time Scale values can be defined. + ![image](https://github.com/user-attachments/assets/130f6250-af5b-41fb-8ae2-016c66fbdedc) ### Transform From a4fbfbfb343c5bfe58d08020d4998403f7fd1b77 Mon Sep 17 00:00:00 2001 From: Arnaud Jamin Date: Thu, 6 Feb 2025 01:50:02 -0500 Subject: [PATCH 12/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3fb649b..24b8d1b 100644 --- a/README.md +++ b/README.md @@ -261,7 +261,7 @@ Displays the gameplay tags of the selected actor. ### Time Scale Used to change the game global time scale. -![Time Scale](https://github.com/arnaud-jamin/Cog/assets/13844285/d19198c5-37dd-400d-a09f-7a5077eb2511) +![Time Scale](https://github.com/user-attachments/assets/fc5a49e7-a04d-42b3-9d83-a8290e261665) - If changed on a client the time scale is also modified on the game server, and replicated to the other clients. - Time Scale can be viewed as a widget in the main menu bar. - Right cliking the Time Scale display the settings, where the specific Time Scale values can be defined.