godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document workaround for running a project with a ZIP data pack

Browse Source 
This closes #4768.

(cherry picked from commit f3ae44e358)
This commit is contained in:
Hugo Locurcio
2021-03-19 16:13:52 +01:00
committed by Rémi Verschelde
parent ff86324204
commit a3bcc4ee1e
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
getting_started/workflow/export/exporting_projects.rst
View File

@@ -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 <https://github.com/godotengine/godot/pull/42123>`__,
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``.