From b677d7d8dea65ae04a00ddbb5284df7b4468cb72 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sun, 13 Sep 2020 15:29:04 +0200 Subject: [PATCH] Document the upsides and downsides of PCK and ZIP pack formats --- .../workflow/export/exporting_projects.rst | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/getting_started/workflow/export/exporting_projects.rst b/getting_started/workflow/export/exporting_projects.rst index 9836c927b..c4e6e1e33 100644 --- a/getting_started/workflow/export/exporting_projects.rst +++ b/getting_started/workflow/export/exporting_projects.rst @@ -147,3 +147,24 @@ flag, and to create a dedicated export preset for automated export: .. code-block:: shell godot --path path/to/project --export "pck" game_name.pck + +PCK versus ZIP pack file formats +-------------------------------- + +Each format has its upsides and downsides. PCK is the default and recommended +format for most use cases, but you may want to use a ZIP archive instead +depending on your needs. + +**PCK format:** + +- Uncompressed format. Larger file size, but faster to read/write. +- Not readable and writable using tools normally present on the user's + operating system, even though there are + `third-party tools `__ + to extract and create PCK files. + +**ZIP format:** + +- 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`).