Project structure

[vaind]

I've had a brief look at this project and tried following the CONTRIBUTING.md to build the project and I have a few suggestions.

Currently, the project is supposed to be checked out into an existing Unreal Engine project as a plugin. This means a developer of sentry-unreal SDK must first create a new UE project (sample), to be able to do any development. This increases the cost-of-entry for new SDK developers. Instead, I'd suggest having a look at https://github.com/getsentry/sentry-unity and think about the following changes:

• move the existing contents to a new directory, e.g. what package-dev is in the Unity SDK, maybe plugin or plugin-dev is a good name? - Refactor: repo structure #61
• move dependency builds to separate CI job & allow downloading for plugin developers - thus moving the binaries from the repository - Remove dependency binaries #63
• add script for packaging and release - Chore/release ci #62
• add a sample project that already includes the development version of the plugin - Add sample project #64
• add a test project that includes a plugin that's ready for distribution (see also Create a CI/CD pipeline for plugin packaging and testing #4), which may be different than the dev version - Integration/smoke test #77

[vaind]

@tustanivsky I understand you have a demo app to simulate event captures locally? Can you maybe add the app to the sample now that we have moved the plugin to plugin-dev from the repo root?

[tustanivsky]

@tustanivsky I understand you have a demo app to simulate event captures locally? Can you maybe add the app to the sample now that we have moved the plugin to plugin-dev from the repo root?

Yes, we can do that. Just wanted to clarify - should it include the plugin as well? Or we're going to copy plugin-dev to the <SampleRoot>/Plugins folder in CI i.e. when running integration tests?

[vaind]

it shouldn't include the plugin - ideally, we can create a symlink?

[tustanivsky]

it shouldn't include the plugin - ideally, we can create a symlink?

I did some quick testing and it looks that UE doesn't recognize symlinks on Windows which is not good considering it's the main platform for Unreal development. On Mac it works just fine though

[vaind]

Which type of link have you tried on Windows? If you could create a PR with the sample as is, I can have a look around and maybe I can think of something.

[tustanivsky]

Which type of link have you tried on Windows? If you could create a PR with the sample as is, I can have a look around and maybe I can think of something.

I've created a PR (#64) with symlink for Mac. On Windows I've tried to create one with mklink, but when launching the project UE doesn't detect any plugins installed