aboutsummaryrefslogtreecommitdiff
path: root/docs/VersioningCompatibility.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2024-02-07 13:26:23 +0100
committerStefan Boberg <[email protected]>2024-02-07 13:26:23 +0100
commitf7b0dc917dd51a981141833fb605ec6e8b7e6947 (patch)
tree671e338a7e587dcafd941643f4e8b0728993c24d /docs/VersioningCompatibility.md
parentAdd testcase and fix for ASIO ipv4 localhost support (#649) (diff)
downloadzen-5.4.1-pre2.tar.xz
zen-5.4.1-pre2.zip
minor docs updatesv5.4.1-pre3v5.4.1-pre2
Diffstat (limited to 'docs/VersioningCompatibility.md')
-rw-r--r--docs/VersioningCompatibility.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/VersioningCompatibility.md b/docs/VersioningCompatibility.md
new file mode 100644
index 000000000..f4a283653
--- /dev/null
+++ b/docs/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.