diff --git a/README.md b/README.md index 27815ce..24b8d1b 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. @@ -59,12 +59,20 @@ 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 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. + +![Cheats Asset](https://github.com/user-attachments/assets/46a14b89-ebab-4628-b97b-e5ccd2b63576) ### Collisions Tester Used to test a collision query @@ -89,6 +97,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. @@ -97,7 +116,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 @@ -149,6 +168,16 @@ 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 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 Display the output log based on each log categories verbosity. @@ -185,15 +214,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 +229,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. @@ -216,18 +245,28 @@ 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 a menu to force the stat to a reach a specific value. +- 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) ### 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. -![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. + +![image](https://github.com/user-attachments/assets/130f6250-af5b-41fb-8ae2-016c66fbdedc) ### Transform Used to read and set the selected actor transform.