https://github.com/DarknessFX/DFoundryFX
Unreal Engine 5 Plugin with Dear ImGUI, customizable performance metric charts (including Shipping builds), Shader compiler monitoring and STAT commands control panel for Unreal Engine GameViewports.
https://github.com/DarknessFX/DFoundryFX
performance performance-metrics plugin unreal-engine unrealengine unrealengine5
Last synced: 5 days ago
JSON representation
Unreal Engine 5 Plugin with Dear ImGUI, customizable performance metric charts (including Shipping builds), Shader compiler monitoring and STAT commands control panel for Unreal Engine GameViewports.
- Host: GitHub
- URL: https://github.com/DarknessFX/DFoundryFX
- Owner: DarknessFX
- License: mit
- Created: 2023-01-11T01:11:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T08:34:55.000Z (7 months ago)
- Last Synced: 2024-09-17T10:30:07.624Z (7 months ago)
- Topics: performance, performance-metrics, plugin, unreal-engine, unrealengine, unrealengine5
- Language: C++
- Homepage:
- Size: 1.95 MB
- Stars: 62
- Watchers: 2
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-game-security - Customizable performance metric charts and STAT commands control panel
README
.----------------. .----------------. .----------------.
| .--------------. || .--------------. || .--------------. |
| | ________ | || | _________ | || | ____ ____ | |
| | |_ ___ `. | || | |_ ___ | | || | |_ _||_ _| | |
| | | | `. \ | || | | |_ \_| | || | \ \ / / | |
| | | | | | | || | | _| | || | > `' < | |
| | _| |___.' / | || | _| |_ | || | _/ /'`\ \_ | |
| | |________.' | || | |_____| | || | |____||____| | |
| | | || | | || | | |
| '--------------' || '--------------' || '--------------' |
'----------------' '----------------' '----------------'
DarknessFX @ https://dfx.lv | Twitter: @DrkFX
# DFoundryFX plugin For Unreal Engine 5
## About
DFoundryFX plugin feature customizable performance metric charts (including Shipping builds),
Shader compiler monitoring and STAT commands control panel for Unreal Engine GameViewports.
While the plugin is enabled you always have access to the charts, controls and settings
directly in your game viewport, this plugin don't need actors or objects to be created
in your project.
## Installation
### Use precompiled plugin (Unreal Engine 5.1 or newer)
. Download the latest release.
. Unzip the file in your UEFolder\Engine\Plugins.
. Start Unreal Engine.
. Menu Tools > Plugins.
. Enable in Installed > Performance > DFoundryFX .
. Restart Unreal Engine.
. Play your project, DFoundryFX window and charts will show up.
### Build from Example
. Visit DFoundryFX_Example repo , download Setup.bat and execute.
. Play your project, DFoundryFX window and charts will show up.
### Build from Source
. Create a new folder. ex: *Plugins\*
. Git clone this project with sub-modules. ex: *git clone --recursive https://github.com/DarknessFX/DFoundryFX.git*
. Open your "**Developer Command Prompt for VisualStudio**" (*Program Files\Microsoft Visual Studio\Common7\Tools\VsDevCmd.bat*).
. Execute *Plugins\DFoundryFX\Source\ThirdParty\ImGui\Build.bat* .
. Copy Plugins\ folder to your project folder (or to your Engine\Plugins folder).
. Open your project in VisualStudio and build.
. Open your project, enabled DFoundryFX in Plugins tab (Installed > Perfomance > DFoundryFX).
. Play your project, DFoundryFX window and charts will show up.
## Credits
Unreal Engine from Epic Games - https://www.unrealengine.com/
DearImGui from @ocornut - https://github.com/ocornut/imgui
ImPlot from @epezent - https://github.com/epezent/implot
MetalWorking Icon from TheNounProject - https://thenounproject.com/icon/metalworking-1563039/
ImGuiPlugin from @amuTBKT - https://github.com/amuTBKT/ImGuiPlugin
UnrealEngine_ImGui from @sronsse - https://github.com/sronsse/UnrealEngine_ImGui
Rama code multi threading from Rama - https://dev.epicgames.com/community/learning/tutorials/7Rz/rama-code-multi-threading-in-ue5-c
## License
@MIT - Free for everyone and any use.
DarknessFX @ https://dfx.lv | Twitter: @DrkFX
https://github.com/DarknessFX/DFoundryFX