Development Setup
VPE uses Unity's Package Manager to fetch its code. For users that's great because they get updates without having to deal with git, and the actual project to work with is very small because the heavy dependencies get pulled in by UPM. We use our own scoped registry. Packages get published automatically when something gets merged or pushed to master.
However, packages are immutable in Unity, meaning code can't be updated and thus they are not suitable for local development. For that, you need to clone each package locally and manually add them to the project.
VPE consists of multiple repositories. We have split them because of two reasons:
- We want to have code separate from the rather heavy assets (textures, models, etc)
- URP and HDRP aren't compatible and cannot live together in the same project (and we support both).
Here an overview of VPE's repositories:
When using the HDRP or URP project, the scoped registry is already set up and Unity will pull in dependencies in from that. So the first step is to remove it. For that, go to project settings, and remove the Visual Pinball Engine registry under Package Manager.
The second step is to clone all the repos:
git clone [email protected]:VisualPinball/VisualPinball.Unity.AssetLibrary.git
git clone [email protected]:VisualPinball/VisualPinball.Unity.AssetLibrary.Hdrp.git
git clone [email protected]:freezy/VisualPinball.Engine.git
git clone [email protected]:VisualPinball/VisualPinball.Unity.Hdrp.git
git clone [email protected]:VisualPinball/VisualPinball.Unity.Urp.gitIn your Unity project, add the repositories as package from disk in the following order:
- VisualPinball.Unity.AssetLibrary
- VisualPinball.Unity.AssetLibrary.Hdrp
- VisualPinball.Engine
- VisualPinball.Unity.Hdrp
When working with URP, use these repositories in this order:
VisualPinball.Unity.AssetLibrary.Urp does not exist yet, but it will be added here when it does.