Skip to content
This repository was archived by the owner on Jun 18, 2026. It is now read-only.

Compatibility Between API Versions

hammy3502 edited this page Mar 7, 2022 · 8 revisions

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!

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.

Getting Started

Getting Started

Logical Sides and Ping Limitations

Version Compatibility

API Interface

IVRAPI

Data Interfaces

IVRPlayer

IVRData

Dev Mode

Dev Mode

Removed

VRPlayerTickEvent (Removed as of 2.0.0 Pre-Release 1)

Clone this wiki locally