Setting Up Vehicle Physics Pro

Welcome to Vehicle Physics Pro (VPP)! The most complete, accurate and realistic vehicle physics kit available for Unity 3D.

VPP is delivered as an example Unity 3D project which uses a set of submodules. The example Unity 3D project may be used as sandbox for testing and learning VPP, or even as a startup template. The submodules may also be included in existing projects directly. See Repository Reference below for details and dependencies.

All projects and submodules are hosted at projects.edy.es as GIT repositories. The credentials for accessing the repositories are sent to you after purchasing the license. You may either clone the repositories via GIT or download them as ZIP files.

Importing the Blender 3D models

Some 3D objects in the repositories are in Blender format (.blend). These models require Blender installed (free) to be imported properly in Unity. Blender site

Cloning the repositories via GIT

Requires GIT installed. I use Git Extensions, an all-in-one setup that installs GIT, tools and a handy UI.

1. Configure the SSH public key

This is strongly recommended. Once configured, access to VPP repositories is pretty straightforward.

  1. Open Git Bash. If you've installed Git Extensions, just right-click any folder and select "Git Bash".

  2. Generate the ssh keys. Paste the text below, substituting in your email address:

    $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
  3. When you're prompted to "Enter a file in which to save the key", press Enter. This accepts the default file location.

  4. Upload the ssh public key (id_rsa.pub) to your account in projects.edy.es.

  5. Test your connection. Enter:

    $ ssh -T git@projects.edy.es

    The first time you will receive a warning. Reply Yes. You should then see this:

    Welcome to Repository Hosting's Git Server. You have been successfully authenticated.
    However you cannot connect directly with SSH, you must use the 'git' command.

    Your connection via SSH is now correct. Proceed to the next step, cloning the VPP project.

2. Clone the VPP example project

  1. Open Git Bash, then cd to a folder where you want the project to be cloned into. If you've installed Git Extensions, just right-click the folder of your choice and select "Git Bash".

  2. Clone the repository and submodules. Type or paste each line (without the $) in Git Bash pressing Enter after each one:

    Professional Edition:

    $ git clone ssh://git@projects.edy.es/edy/vehicle-physics-pro-professional.git
    $ cd vehicle-physics-pro-professional
    $ git submodule update --init --recursive

    Enterprise Edition:

    $ git clone --depth=1 ssh://git@projects.edy.es/edy/vehicle-physics-pro.git
    $ cd vehicle-physics-pro
    $ git submodule update --init --recursive

    The repository will be created in a folder with the name of the repository.

  3. Now you can open the project in Unity 3D. Proceed to Getting Started for a quick walkthrough.

3. Update to the most recent version

Fetch the most recent updates to the example project.

  1. Open Git Bash, then cd to the folder where the Untiy project is located. If you've installed Git Extensions, just right-click the folder and select "Git Bash".

  2. Fetch and update the repositories. Type or paste each line (without the $) in Git Bash pressing Enter after each one:

    $ git pull --recurse-submodules
    $ git submodule update --init --recursive

Continuous Integration systems

If you're using a CI system such as TeamCity, ensure to set the refresh interval to a reasonable rate. 1-2 times per day is enough for VPP repositories (12 hours = 720 minutes = 43200 seconds).

Downloading as ZIP files

  1. Download and unzip the Unity 3D project for your VPP edition. Open the repository log below, then click the topmost zip link for downloading the latest zip snapshot:

    Professional Edition   |   Enterprise Edition

  2. Repeat the process for each submodule below. Unzip each one to the specified location in the project:

    Professional Edition submodules Folder
    Vehicle Physics Pro SDK Assets/Vehicle Physics Pro/Sdk
    Vehicle Physics Sample Assets (master-sdk branch) Assets/Vehicle Physics Pro/Sample Assets
    Enterprise Edition submodules Folder
    Common Tools Core Assets/Core/Common Tools Core
    Vehicle Physics Core Assets/Core/Vehicle Physics Core
    Vehicle Physics Sample Assets (master branch) Assets/Core/Vehicle Physics Sample Assets
    Vehicle Physics Specialized Assets Assets/Core/Vehicle Physics Specialized Assets
  3. Now you can open the project in Unity 3D. Proceed to Getting Started for a quick walkthrough.

Using VPP in existing projects

Simply include the VPP repositories as folders or GIT submodules under the Assets folder in your Unity project. See the Repository Reference below for GIT URLs and requirements.

Professional Edition

The repository Vehicle Physics Pro SDK contains everything needed to run VPP vehicles. Additionally, you may include Vehicle Physics Sample Assets (master-sdk branch) for quick prototyping.

Enterprise Edition

Enterprise Edition requires Common Tools Core and Vehicle Physics Core to run VPP vehicles. Additionally, you may include Vehicle Physics Sample Assets for quick prototyping. The repository Vehicle Physics Specialized Assets includes utility scripts to run specialized vehicles such as excavators, caterpillars, dumpers, etc.

Repository reference

Professional Edition

VPP Professional Edition repositories

Repository URLs Description
Vehicle Physics Pro - Professional GIT‑SSH
ZIP
Example project for Unity 3D with development assets and example scenes.

Note: The ZIP snapshot doesn't include the submodules. Downloading as ZIP requires the submodules below to be downloaded separately and placed in the corresponding folders under Assets/Vehicle Physics Pro.
Vehicle Physics Pro SDK GIT‑SSH
GIT‑HTTP
ZIP
Submodule with the Vehicle Physics Pro SDK files.
This repo contains everything needed to run VPP in existing projects.
Vehicle Physics Sample Assets GIT‑SSH
GIT‑HTTP
ZIP
Submodule with a set of assets and resources for prototyping and tests.
Requires Vehicle Physics Pro SDK.

Important: check-out or download the master-sdk branch instead of master for this repo to work with the VPP SDK files.

Enterprise Edition

VPP Enterprise Edition repositories

Repository URLs Description
Vehicle Physics Pro - Enterprise GIT‑SSH
ZIP
Example project for Unity 3D with source code, examples, development resources, etc.

Note: The ZIP snapshot doesn't include the submodules. Downloading as ZIP requires the submodules below to be downloaded separately and placed in the corresponding folders under Assets/Core.
Common Tools Core GIT‑SSH
GIT‑HTTP
ZIP
Submodule with common tools and utility scripts.
Vehicle Physics Core GIT‑SSH
GIT‑HTTP
ZIP
Submodule with the vehicle physics simulation scripts and components.
Requires Common Tools Core.
This repo together with Common Tools Core is everything needed to run VPP in existing projects.
Vehicle Physics Sample Assets GIT‑SSH
GIT‑HTTP
ZIP
Submodule with a set of assets and resources for prototyping and tests.
Requires Common Tools Core and Vehicle Physics Core.
Vehicle Physics Specialized Assets GIT‑SSH
GIT‑HTTP
ZIP
Submodule with specialized vehicle support (excavators, loaders, caterpillars, etc).
Requires Common Tools Core and Vehicle Physics Core.