Ecosystem and Compatibility - HoshiKurama/TicketManager GitHub Wiki

Ecosystem

The TicketManager ecosystem is comprised of several components:

  • API (TM:API): While not a plugin, TM:API defines how various components interact with each other. This is what extensions should target.
  • Core (TM:Core): Contains the API, implementations, and entry points used by developers and TM:SE for extension registration. Provides functionality to TM:SE.
  • Standalone Edition (TM:SE): Generally what people think of by TicketManager. This is the main plugin which ties the functionality of all TM components together.
  • Proxy Bridge Edition (TM:PBE): Handles the forwarding of proxy-related behaviour to other servers in a network.

Every server needs 1 TM:SE and 1 TM:Core. Networks will also need to install 1 PBE on the proxy. Finally, there is one more category:

  • Extensions: These are distinct plugins which hook into TM:API via TM:Core and change the way TM:SE operates. They can be official or community-created!

Compatibility

TicketManager assumes all compatibilities are met during runtime. That is, end-users are responsible for providing a proper operational environment. This page tabulates compatibility between:

  1. the SE and server version
  2. the PBE and proxy version
  3. the SE and the PBE.
  4. the Core and everything other than the PBE

Note: this page does not tabulate extension information. Please follow instructions given by the extension repository or developer

Guide

All tables on this page utilize colour coding to denote compatibility.

Standalone Edition Compatibility

Paper

Spigot

Proxy Bridge Edition Compatibility

Velocity

Waterfall

SE ↔ PBE Compatibility

When creating a TM network, users must consider compatibility between the PBE and SE(s).

Core Compatibility

The core works differently from other components. Given version X.Y.Z, X.Y for TM:SE and TM:Core will always match the API version and should be consequently used with each other.