Improve messaging when git submodules are not loaded #230
Description
Is there an existing issue for this?
- I have searched the existing issues and added correct labels.
Please describe the feature you have in mind and explain what the current shortcomings are?
It often comes up that starting dev with ayon-unreal is a bit unpleasant. An often missed oversight is the git submodules. Then running dev mode or building a package generates errors like the ones shown here: https://community.ynput.io/t/developer-workflow/2683/5?u=bigroy
Failed: Path to plugin integration is null!
Suggested implementation?
Add notes to the README.md that this repo contains submodules.
git clone --recursive https://github.com/ynput/ayon-unreal.git
or when you already cloned it, just run:
git submodule update --init --recursive
If it's important to always update the git submodules after switching branches, e.g. it may be good to document that as well.
Additionally, I think we should improve the error message:
Failed: Path to plugin integration is null!
To report instead:
Failed: AYON Unreal plug-in integration not found. A common cause is running from source or packages built from the git repository with the submodules not initialized. Please run `git submodule update --init --recursive` in the git repository to ensure submodules are initialized and updated.
Or whatever tells that same thing, but shorter. :)
Describe alternatives you've considered:
No response