aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/VersioningCompatibility.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2026-03-23 12:23:19 +0100
committerGitHub Enterprise <[email protected]>2026-03-23 12:23:19 +0100
commit26aa50677403e4c5ad053b221bc7264fe1d249f2 (patch)
treede196528390e8875b0551d52071038120d969f73 /docs/dev/VersioningCompatibility.md
parentProcess management improvements (#881) (diff)
downloadzen-26aa50677403e4c5ad053b221bc7264fe1d249f2.tar.xz
zen-26aa50677403e4c5ad053b221bc7264fe1d249f2.zip
Documentation updates (#882)
Restructured the docs folder in preparation for more docs. Improved the contents a bit.
Diffstat (limited to 'docs/dev/VersioningCompatibility.md')
-rw-r--r--docs/dev/VersioningCompatibility.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/dev/VersioningCompatibility.md b/docs/dev/VersioningCompatibility.md
new file mode 100644
index 000000000..f4a283653
--- /dev/null
+++ b/docs/dev/VersioningCompatibility.md
@@ -0,0 +1,17 @@
+# Zen Storage Server Versioning
+
+Any API changes made in the Zen Storage Server must be backwards compatible. That is to say, a newer
+version of the server must be compatible with older versions of client code (typically, the Unreal Engine
+editor or runtime). This means you can use any newer version of the server with some version of the engine.
+For example, using Zen Server 5.5.0 with an engine version of 5.4.3 would be perfectly valid and in some
+cases this may be desirable to get improvements in performance or functionality from newer versions of
+the server without upgrading the engine.
+
+Newer clients may not be backwards compatible however, which means that you will generally not be able to
+use an older server version with more recent UE versions.
+
+The server is versioned such that you can easily correlate the server version with the engine version. Thus
+in the Unreal Engine v5.4.0 release the server will be tagged with 5.4.0 which indicates that it is
+compatible with the 5.4.0 (and earlier) runtime. As updates are made, new versions may be released and these
+will have a higher minor version number (5.4.1, 5.4.2 etc) but these will not necessarily line up with point
+releases of the engine since there may be more or fewer updates to the server than to the engine.