Support for Unreal 5 #9

pasotee · 2023-09-09T05:13:30Z

Here is a draft for the Unreal Engine upgrade.

So far I've tested with Unreal Engine 5.2 Windows & MacOs. Since 5.3 got out this week, I will run the plugin on that version too as well as a Linux machine.

Based on my tests it seems there might be a few changes required in the C++ SDK as well. I will create a PR for that and link it in.

Fixes #8

pasotee · 2023-09-09T05:14:34Z

BrainFlowPlugin/Source/BrainFlowPlugin/BrainFlowPlugin.Build.cs

            RuntimeDependencies.Add("$(TargetOutputDir)/BoardController.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "BoardController.dll"));
            RuntimeDependencies.Add("$(TargetOutputDir)/DataHandler.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "DataHandler.dll"));
            RuntimeDependencies.Add("$(TargetOutputDir)/GanglionLib.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "GanglionLib.dll"));
-            RuntimeDependencies.Add("$(TargetOutputDir)/gforce64.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "gforce64.dll"));
-            RuntimeDependencies.Add("$(TargetOutputDir)/gForceSDKWrapper.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "gForceSDKWrapper.dll"));
+            //RuntimeDependencies.Add("$(TargetOutputDir)/gforce64.dll", Path.Combine(ModuleDirectory, "Compiled", "x64_dynamic", "lib", "gforce64.dll"));


Those dlls seem to be missing (they are built by the python script but not copied over).

Are they still relevant should I look into copying them over or should I remove them from here?

They are not missed, they are copied if you run python script with --oymotion option and it seems like I forgot to add this option to readme.
I also considered an option to take dlls from this job which stored all possible libs as github artifacts https://github.com/brainflow-dev/brainflow/actions/workflows/deploy_cpp_libs.yml but ended up using submodules because it was easier for me but maybe not for users

btw in fact there are some missing libraries inside this unreal engine build script, for example simpleble, muse_bglib, etc. Need to add them to support all possible devices. You can set all options in build.py to true to see the full list of libs

also maybe it makes sense to write a method which will go through files in lib folder after compilation and add all of them ro runtimedependencies. It will look better than hardcoding names, especially including the fact that there are different build options

I also considered an option to take dlls from this job which stored all possible libs as github artifacts https://github.com/brainflow-dev/brainflow/actions/workflows/deploy_cpp_libs.yml but ended up using submodules because it was easier for me but maybe not for users

My suggestion, especially if you want to publish this to the maketplace sometime soon, is to push the precompiled binaries into this repo. I know it's not ideal to have binary files in git, but it really makes the publishing process to marketplace easier + you are sure if someone clones they are using a compatible version (UE SDK - C++ SDK). The job you have there seems perfect we just need to make sure it supports all the platforms you care about. I also wrote something similar here: https://github.com/outoftheboxplugins/configcat-unreal/actions/runs/5833331101

It's still very important to give the users some instructions about compiling locally because they might need to change the C++ SDK.

also maybe it makes sense to write a method which will go through files in lib folder after compilation and add all of them ro runtimedependencies. It will look better than hardcoding names, especially including the fact that there are different build options

Yes, it makes total sense. I actually did something similar a few weeks ago for this plugin: https://github.com/outoftheboxplugins/configcat-unreal/blob/main/Source/ThirdParty/ConfigCatCppSDK/ConfigCatCppSdk.Build.cs

I wanted to keep the changes of the PR to a minimum, but I am happy to implement it here for this PR or next ones.

btw in fact there are some missing libraries inside this unreal engine build script, for example simpleble, muse_bglib, etc. Need to add them to support all possible devices. You can set all options in build.py to true to see the full list of libs

I think if we deliver pre-built binaries we can just include all in the repo and we can adjust the Build.cs accordingly.

I think we can setup jobs to compile everything and push to marketplace wo pushing binaries to git, but can add binaries to the repo also if needed. The main requirement - it should be simple to update and dont take too much time to maintain, so probably smth like cron job with personal access token will be ok.

Lets fix this ugly hardcode for dyn libs and iterate over files in libs dir as a part of this PR

Sounds good, I've adjust the DLLs and the libs discovery.

Since this is a bigger change, I would love to know if you can suggest some tests to confirm everything is working well. (I've tried building some bits from https://brainflow.readthedocs.io/en/stable/Examples.html#id2). Or if you know someone who's using this with Unreal, I would be happy to get in touch with them and confirm it works for them.

this test is ok you can use it with synthetic board and see if you can read some data

did you manage to get some data using this sample?

Yes. Thanks again for all the help both here and on slack. I was able to get the sample data both for at editortime (Play in Editor) and runtime (packaged game).

I've modified the file as discussed, the brainflow.lib is statically linked in the .exe and the 3 DLL files (board controller, ml module, data handler) are dynamically linked. All other DLL are copied over to the final build so they can loaded if needed.

pasotee · 2023-09-09T05:26:17Z

PR with the C++ SDK fix: brainflow-dev/brainflow#672

BrainFlowPlugin/Source/BrainFlowPlugin/BrainFlowPlugin.Build.cs

Andrey1994

what was the exact issue in unreal engine 5? looks like just minor changes in paths and removed win32, but not sure how important they are

pasotee · 2023-09-10T05:46:47Z

what was the exact issue in unreal engine 5? looks like just minor changes in paths and removed win32, but not sure how important they are

I also was expecting bigger problems, but they turned out to be quiet minor.

I think the deprecation of PublicLibraryPaths was holding people back. Since it was removed, the paths of the lib/dll files also needed adjustments. Otherwise it was a quiet simple update remove Win32.

Andrey1994 · 2023-09-21T16:09:47Z

BrainFlowPlugin/Source/BrainFlowPlugin/BrainFlowPlugin.Build.cs

-            PublicDelayLoadDLLs.Add("libBoardController.dylib");
-            PublicDelayLoadDLLs.Add("libDataHandler.dylib");
-            PublicDelayLoadDLLs.Add("libMLModule.dylib");
+            PublicDelayLoadDLLs.Add(Path.Combine(PrecompiledFolder, "libBoardController.dylib"));


should it be the same for linux?

I actually don't know without testing.

On Windows, I found the PublicDelayLoadDLLs need to be filename only and manually loaded in the module file to work, but they won't work with full path.

On Mac, I found the PublicDelayLoadDLLs will automatically get loaded properly if the full path is provided which I found easier and nice.

On Linux, I got no clue what will work, but I hope the full path will be working there too. I will make the adjustments

pasotee added 6 commits September 8, 2023 20:32

removed deprecated win32 target

b6d6f27

update to 5.2

b9a42ed

added setup steps for macos arm64

e0b84cf

Windows test

a90e787

standard unreal ignore

07f12e3

formatting

c852eea

pasotee commented Sep 9, 2023

View reviewed changes

Andrey1994 reviewed Sep 9, 2023

View reviewed changes

BrainFlowPlugin/Source/BrainFlowPlugin/BrainFlowPlugin.Build.cs Show resolved Hide resolved

Andrey1994 reviewed Sep 9, 2023

View reviewed changes

refactor hardcoded DLLs and libs

a78d5a2

Andrey1994 approved these changes Sep 11, 2023

View reviewed changes

pasotee added 3 commits September 14, 2023 10:38

refactor to only link a few dlls but copy all to final build

04f7020

Fixed for windows linking errors + packaged game test + example test

338e7ab

tested on mac editor + package

b931801

Andrey1994 reviewed Sep 21, 2023

View reviewed changes

switched to full path DLLs for Linux too.

6c79ff8

Andrey1994 merged commit da8513c into brainflow-dev:master Sep 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Unreal 5 #9

Support for Unreal 5 #9

pasotee commented Sep 9, 2023 •

edited

Loading

pasotee Sep 9, 2023

Andrey1994 Sep 9, 2023

Andrey1994 Sep 9, 2023

Andrey1994 Sep 9, 2023 •

edited

Loading

pasotee Sep 10, 2023

Andrey1994 Sep 11, 2023 •

edited

Loading

pasotee Sep 11, 2023

Andrey1994 Sep 11, 2023

Andrey1994 Sep 11, 2023

pasotee Sep 14, 2023

pasotee commented Sep 9, 2023

Andrey1994 left a comment

pasotee commented Sep 10, 2023

Andrey1994 Sep 21, 2023

pasotee Sep 22, 2023

Support for Unreal 5 #9

Support for Unreal 5 #9

Conversation

pasotee commented Sep 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Andrey1994 Sep 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Andrey1994 Sep 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pasotee commented Sep 9, 2023

Andrey1994 left a comment

Choose a reason for hiding this comment

pasotee commented Sep 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pasotee commented Sep 9, 2023 •

edited

Loading

Andrey1994 Sep 9, 2023 •

edited

Loading

Andrey1994 Sep 11, 2023 •

edited

Loading