diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CODING.md | 2 | ||||
| -rw-r--r-- | docs/VersioningCompatibility.md | 17 |
2 files changed, 18 insertions, 1 deletions
diff --git a/docs/CODING.md b/docs/CODING.md index c4be7906c..2452e6ef0 100644 --- a/docs/CODING.md +++ b/docs/CODING.md @@ -20,5 +20,5 @@ Formatting is ensured by using [pre-commit](https://pre-commit.com/) - [Ensure you have a Python install](https://www.python.org/downloads/) and that Python has been added to the PATH environment variable - [Install pre-commit](https://pre-commit.com/#installation) so it is available in PATH - Run pre-commit manually on staged files `pre-commit run` -- Run pre-commit manually on all files `pre-commit run --all-files` +- Run pre-commit manually on all files `pre-commit run --all-files`. There is also a `xmake precommit` shortcut which may be easier to remember - Install git commit hooks `pre-commit install`, which will automatically run before every commit. 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. |