Compatibility Between API Versions

mc-vr-api uses semantic versioning. Put simply, for a given x.y.z release:

Versions where x are different are not compatible. For example, if a mod was built with API version 1.y.z but a user is running the API with the version 2.y.z, things will not work! NOTE: There is currently a plan to create a 3.y.z release, see #14

Versions where y are different are forwards compatible. For example, if a mod was built with the API version 1.0.z, but a user is running the API with the version 1.1.0, things will work fine, however any features introduced in 1.1.z will not work. HOWEVER, if a mod was built with the API version 1.1.z but the user is running the API with the version 1.0.z, using any features from 1.1.z will fail!

Versions where z are different are fully compatible. For example, if a mod was built with the API version 1.0.0 but a user is running the API with the version 1.0.9, no issues should occur.

The beta release 1.0.0-beta1 is a pre-release, and does not work with 1.0.z or later.

WARNING: The server and client must be running the same major and minor version! For example, 1.3.1 and 1.3.2 are compatible, but 1.2.3 and 1.3.0 are not compatible and 1.1.1 and 2.1.1 are not compatible!

NOTE: If you are building directly from master (or some other development branch) no guarantees about version-compatibility are made in any way! If you want to ensure compatibility, stick to versions from CurseForge or the GitHub Releases page.