From a3bcc4ee1ef2be8ef8fd103b6b3348b833a3c140 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 19 Mar 2021 16:13:52 +0100 Subject: [PATCH] Document workaround for running a project with a ZIP data pack This closes #4768. (cherry picked from commit f3ae44e358e92ab8cd2d580fad284556e5ea6cfe) --- .../workflow/export/exporting_projects.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/getting_started/workflow/export/exporting_projects.rst b/getting_started/workflow/export/exporting_projects.rst index 6ac8fb191..e65974643 100644 --- a/getting_started/workflow/export/exporting_projects.rst +++ b/getting_started/workflow/export/exporting_projects.rst @@ -177,3 +177,21 @@ depending on your needs. - Compressed format. Smaller file size, but slower to read/write. - Readable and writable using tools normally present on the user's operating system. This can be useful to make modding easier (see also :ref:`doc_exporting_pcks`). + +.. warning:: + + Due to a `known bug `__, + when using a ZIP file as a pack file, the exported binary will not try to use + it automatically. Therefore, you have to create a *launcher script* that + the player can double-click or run from a terminal to launch the project:: + + :: launch.bat (Windows) + @echo off + my_project.exe --main-pack my_project.zip + + # launch.sh (Linux) + ./my_project.x86_64 --main-pack my_project.zip + + Save the launcher script and place it in the same folder as the exported binary. + On Linux, make sure to give executable permissions to the launcher script using + the command ``chmod +x launch.sh``.