From 3f5aa81858364ab793b98883b3690bfc4d0c5f35 Mon Sep 17 00:00:00 2001 From: Steve Streeting Date: Wed, 14 Jun 2023 15:35:04 +0100 Subject: [PATCH] Clarify .uplugin update policy --- doc/PluginPackage.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/PluginPackage.md b/doc/PluginPackage.md index d1999ed..5db5d3f 100644 --- a/doc/PluginPackage.md +++ b/doc/PluginPackage.md @@ -4,9 +4,12 @@ To distribute a plugin on the marketplace, you need to zip it up and make sure you only include approved files. The `ue-plugin-package.ps1` script is here to make that job easier. -> Note: unless you use the `-keepversion`, the script will update your .uplugin -> file to record the new version number and potentially set Installed=true. -> Unfortunately the first time, this will probably mess with indents. +> **Note:** This script will update your .uplugin file to record the new version number, +> and manipulate EngineVersion for each build. Its state will be restored afterwards +> (apart from the version number). +> +> Unfortunately the first time, this will probably mess with indenting because +> of a difference of opinion between JSON libraries. But it's harmless. ```sh Usage: