HWPFormat: Add warning about non-recursivity
Fri, 14 Apr 2017 02:21:45 +0100
changeset 959 b167ea1e5563
parent 958 4e4e81083786
child 960 7d07934c1fee
HWPFormat: Add warning about non-recursivity
--- a/HWPFormat.wiki	Wed Apr 12 19:41:10 2017 +0100
+++ b/HWPFormat.wiki	Fri Apr 14 02:21:45 2017 +0100
@@ -52,6 +52,11 @@
 Using sidecar HWPs is useful for Lua scripters who want to provide a few resources for your script but don’t want to force users to install them globally or to fiddle around with their user data directory. Especially if using the resources only really makes sense together with the script.
+=== Limitations ===
+'''Important''': HWPs are ''not'' recursive! This means if you put a HWP inside another HWP, Hedgewars will only load the actual contents of the outermost HWP. The contents of the inner HWP are not loaded. This implies that there is currently no way (via HWP) to distribute a script with custom data. You have to ask users to just extract a normal Zip file with your script data instead.
+This is considered a bug, see https://issues.hedgewars.org/show_bug.cgi?id=174.
 === Order of precedence ===
   # Sidecar HWPs