mirror of
https://github.com/Ed94/Cog.git
synced 2026-08-04 14:48:45 +00:00
Update README.md
This commit is contained in:
@@ -30,6 +30,8 @@ Displays the gameplay abilities of the selected actor.
|
|||||||
- Right click an ability to remove it, or open/close the ability separate window.
|
- 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.
|
- Use the 'Give Ability' menu to manually give an ability from a list defined in a Data Asset.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
Displays the state of Input Action.
|
Displays the state of Input Action.
|
||||||
|
|
||||||
@@ -37,6 +39,8 @@ Displays the state of Input Action.
|
|||||||
- 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.
|
- 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.
|
- The display input action are read from a Input Mapping Context defined in a Data Asset.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Attributes
|
### Attributes
|
||||||
Displays the gameplay attributes of the selected actor.
|
Displays the gameplay attributes of the selected actor.
|
||||||
|
|
||||||
@@ -46,16 +50,22 @@ Displays the gameplay attributes of the selected actor.
|
|||||||
- Attributes with the Current value lower than the Base value are displayed in red.
|
- 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.
|
- Use the options 'Show Only Modified' to only show the attributes that have modifiers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Behavior Tree
|
### Behavior Tree
|
||||||
Displays the behavior tree of the selected actor.
|
Displays the behavior tree of the selected actor.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Blackboard
|
### Blackboard
|
||||||
Displays the blackboard of the selected actor.
|
Displays the blackboard of the selected actor.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Cheats
|
### Cheats
|
||||||
Used to apply cheats to the selected actor.
|
Used to apply cheats to the selected actor.
|
||||||
|
|
||||||
@@ -74,6 +84,8 @@ Used to apply cheats to the selected actor.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Collisions Tester
|
### Collisions Tester
|
||||||
Used to test collision queries
|
Used to test collision queries
|
||||||
|
|
||||||
@@ -82,6 +94,8 @@ Used to test collision queries
|
|||||||
|
|
||||||
[Video](https://github.com/user-attachments/assets/aa1096d3-375d-4789-b274-923c36588a5b)
|
[Video](https://github.com/user-attachments/assets/aa1096d3-375d-4789-b274-923c36588a5b)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Collisions Viewer
|
### Collisions Viewer
|
||||||
Used to inspect collisions in the world
|
Used to inspect collisions in the world
|
||||||
|
|
||||||
@@ -89,12 +103,16 @@ Used to inspect collisions in the world
|
|||||||
- The query can be configured in the options.
|
- The query can be configured in the options.
|
||||||
- It can be used to better understand what object collisions are blocking a raycast.
|
- It can be used to better understand what object collisions are blocking a raycast.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Command Bindings
|
### Command Bindings
|
||||||
Used to configure the command bindings.
|
Used to configure the command bindings.
|
||||||
|
|
||||||

|

|
||||||
- Bindings are used to trigger console commands from a keyboard shortcuts, which are saved in `Saved/Config/WindowEditor/Input.ini` (in editor).
|
- Bindings are used to trigger console commands from a keyboard shortcuts, which are saved in `Saved/Config/WindowEditor/Input.ini` (in editor).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Console
|
### Console
|
||||||
Used as a replacement of the Unreal console command.
|
Used as a replacement of the Unreal console command.
|
||||||
|
|
||||||
@@ -106,17 +124,23 @@ Used as a replacement of the Unreal console command.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Debug Settings
|
### Debug Settings
|
||||||
Used to tweak how the debug display is drawn.
|
Used to tweak how the debug display is drawn.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Effects
|
### Effects
|
||||||
Displays the gameplay effects of the selected actor.
|
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, etc.
|
- Mouse over an effect to see its details such as its modifiers, the gameplay tags it grants, the remaining time, etc.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Gamepad
|
### Gamepad
|
||||||
Display the state of the gamepad
|
Display the state of the gamepad
|
||||||
|
|
||||||
@@ -124,6 +148,8 @@ Display the state of the gamepad
|
|||||||
- Can be displayed as an overlay
|
- Can be displayed as an overlay
|
||||||
- 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.
|
- 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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Inspector
|
### Inspector
|
||||||
Used to inspect and modify an Object properties
|
Used to inspect and modify an Object properties
|
||||||
|
|
||||||
@@ -132,6 +158,8 @@ Used to inspect and modify an Object properties
|
|||||||
- Favorites can be added with a custom function defining what happens when the user press the Apply button (typically this can be used to modify and apply the Game User Settings)
|
- Favorites can be added with a custom function defining what happens when the user press the Apply button (typically this can be used to modify and apply the Game User Settings)
|
||||||
- Manage a history of inspected objects.
|
- Manage a history of inspected objects.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Log Categories
|
### Log Categories
|
||||||
Can be used to activate and deactivate log categories
|
Can be used to activate and deactivate log categories
|
||||||
|
|
||||||
@@ -142,6 +170,8 @@ Can be used to activate and deactivate log categories
|
|||||||
- A client can modify the verbosity of the server.
|
- A client can modify the verbosity of the server.
|
||||||
- The log categories are used to filter both the output log and the debug draw.
|
- The log categories are used to filter both the output log and the debug draw.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Metric
|
### Metric
|
||||||
Gather various values sent by the selected actor and compute their rate per second. This is typically used to compute the damage dealt or received per second.
|
Gather various values sent by the selected actor and compute their rate per second. This is typically used to compute the damage dealt or received per second.
|
||||||
|
|
||||||
@@ -152,11 +182,15 @@ Gather various values sent by the selected actor and compute their rate per seco
|
|||||||
FCogDebugMetric::AddMetric(this, "Damage Dealt", MitigatedDamage, UnmitigatedDamage, false);
|
FCogDebugMetric::AddMetric(this, "Damage Dealt", MitigatedDamage, UnmitigatedDamage, false);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Net Emulation
|
### Net Emulation
|
||||||
Used to configure the network emulation
|
Used to configure the network emulation
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### NetImgui
|
### NetImgui
|
||||||
Handle connections to a [NetImgui](https://github.com/sammyfreg/netImgui) server.
|
Handle connections to a [NetImgui](https://github.com/sammyfreg/netImgui) server.
|
||||||
|
|
||||||
@@ -166,6 +200,8 @@ 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.
|
This can be used to debug the state of the game server. For example the behavior trees are only available on the game server.
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Notifications
|
### Notifications
|
||||||
Use to display and configure notifications
|
Use to display and configure notifications
|
||||||
|
|
||||||
@@ -176,18 +212,24 @@ Use to display and configure notifications
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Output Log
|
### Output Log
|
||||||
Display the output log based on each log categories verbosity.
|
Display the output log based on each log categories verbosity.
|
||||||
|
|
||||||

|

|
||||||
- The verbosity of each log category can be configured in the 'Log Categories' window.
|
- The verbosity of each log category can be configured in the 'Log Categories' window.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Pools
|
### Pools
|
||||||
Displays attributes of the selected actor as pools.
|
Displays attributes of the selected actor as pools.
|
||||||
|
|
||||||

|

|
||||||
- The pools can be configured in a data asset.
|
- The pools can be configured in a data asset.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Plots
|
### Plots
|
||||||
Plots values and events overtime. When applicable, only the values and events of the selected actor are displayed.
|
Plots values and events overtime. When applicable, only the values and events of the selected actor are displayed.
|
||||||
|
|
||||||
@@ -208,11 +250,15 @@ Plots values and events overtime. When applicable, only the values and events of
|
|||||||
FCogDebugPlot::PlotEventStop(this, "Effects", RemovedGameplayEffect.Spec.Def->GetFName());
|
FCogDebugPlot::PlotEventStop(this, "Effects", RemovedGameplayEffect.Spec.Def->GetFName());
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Scalability
|
### Scalability
|
||||||
Used to configure the rendering quality.
|
Used to configure the rendering quality.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Selection
|
### Selection
|
||||||
Used to select an actor either by picking an actor in the world or by selecting an actor in the actor list.
|
Used to select an actor either by picking an actor in the world or by selecting an actor in the actor list.
|
||||||
|
|
||||||
@@ -220,6 +266,8 @@ Used to select an actor either by picking an actor in the world or by selecting
|
|||||||
- The actor list can be filtered by actor type (Actor, Character, etc).
|
- The actor list can be filtered by actor type (Actor, Character, etc).
|
||||||
- The current selection is used by various debug windows to filter out their content.
|
- The current selection is used by various debug windows to filter out their content.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Settings
|
### Settings
|
||||||
Configure the settings of Cog.
|
Configure the settings of Cog.
|
||||||
|
|
||||||
@@ -229,6 +277,8 @@ Configure the settings of Cog.
|
|||||||
- Change Cog Shorctuts
|
- Change Cog Shorctuts
|
||||||
- Change the DPI Scaling. Use `[Ctrl][MouseWheel]` to change the DPI.
|
- Change the DPI Scaling. Use `[Ctrl][MouseWheel]` to change the DPI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Skeleton
|
### Skeleton
|
||||||
Display the bone hierarchy and the skeleton debug draw of the selected actor if it has a Skeletal Mesh.
|
Display the bone hierarchy and the skeleton debug draw of the selected actor if it has a Skeletal Mesh.
|
||||||
|
|
||||||
@@ -237,11 +287,15 @@ Display the bone hierarchy and the skeleton debug draw of the selected actor if
|
|||||||
- Right click a bone to access more debug display.
|
- Right click a bone to access more debug display.
|
||||||
- Use the `[Ctrl]` key to toggle the bone debug draw recursively.
|
- Use the `[Ctrl]` key to toggle the bone debug draw recursively.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Spawn
|
### Spawn
|
||||||
Used to spawn new actors in the world. The spawn list can be configured in a Data Asset.
|
Used to spawn new actors in the world. The spawn list can be configured in a Data Asset.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Stats
|
### Stats
|
||||||
Displays engine stats such as FPS, Ping, Packet Loss.
|
Displays engine stats such as FPS, Ping, Packet Loss.
|
||||||
|
|
||||||
@@ -253,11 +307,15 @@ Displays engine stats such as FPS, Ping, Packet Loss.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Tags
|
### Tags
|
||||||
Displays the gameplay tags of the selected actor.
|
Displays the gameplay tags of the selected actor.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Time Scale
|
### Time Scale
|
||||||
Used to change the game global time scale.
|
Used to change the game global time scale.
|
||||||
|
|
||||||
@@ -268,6 +326,8 @@ Used to change the game global time scale.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Transform
|
### Transform
|
||||||
Used to read and set the selected actor transform.
|
Used to read and set the selected actor transform.
|
||||||
|
|
||||||
@@ -276,6 +336,8 @@ Used to read and set the selected actor transform.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Tweaks
|
### Tweaks
|
||||||
Used to apply tweaks to all the spawned actors
|
Used to apply tweaks to all the spawned actors
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user