@@ -66,3 +66,45 @@ following subprojects depend on this
6666* `/forge`: specific implementation for Forge servers
6767
6868Note that this is a server only mod, and will not work on clients.
69+
70+ # # Version matrix
71+
72+ The following table documents mod compatibility for older versions of Minecraft and their platforms.
73+ Any versions prior to 1.12.1 are backports.
74+
75+ If a Minecraft version is not listed here, then no version of the mod exists for it.
76+
77+ All version branches will follow the name `minecraft/<version>`.
78+
79+ | Minecraft | Java | Bukkit | Forge | Fabric | Links |
80+ |-----------|------|--------|-------|--------|-------------------------------------------------------------------------|
81+ | 1.21.1 | 21 | ✅ | ✅ | ✅ | (master) |
82+ | 1.18.2 | 17 | ❌ | ❌ | ✅ | [Branch](https://github.com/CSSUoB/CSS-Minecraft/tree/minecraft/1.18.2) |
83+ | 1.12.2 | 8 | ❌ | ✅ | ❌ | [Branch](https://github.com/CSSUoB/CSS-Minecraft/tree/minecraft/1.12.2) |
84+
85+ **Never merge `minecraft/*` branches into master.** Build features/fixes in master and cherry-pick backwards.
86+
87+ # ## Upgrading to future versions
88+
89+ The `master` branch should always target the latest version.
90+ Before upgrading, create a new release branch for the current version using the naming
91+ scheme `minecraft/<version>`.
92+
93+ Then, make the necessary changes to upgrade Minecraft version. Bukkit / Spigot / Paper
94+ has a stable enough API where not many changes will be needed (if any at all), but
95+ other platforms will likely break.
96+
97+ Once changes are done, update the version matrix and open a new PR to `master`.
98+
99+ # ## Backporting to older versions
100+
101+ This mod was originally made for Minecraft 1.21, thus
102+ it will require backporting to work on older modpacks.
103+
104+ Create a branch from the nearest Minecraft version and name it `minecraft/<version>`.
105+ You may be required to change the Java version, or upgrade/downgrade Gradle.
106+ It should be noted that Fabric does not exist prior to Minecraft 1.14.
107+
108+ Once finished, push the branch to GitHub and update this version matrix with the platform
109+ and version you have backported.
110+
0 commit comments