HWPFormat.wiki
author Wuzzy
Mon, 09 Jul 2018 20:34:30 +0100
changeset 1438 e7214d0ff6e8
parent 1437 b5f72d663141
child 1439 b01fa5ac341e
permissions -rw-r--r--
HWPFormat: HWP vs ZIP
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1435
1a8cc20ce16c HWPFormat: Add TOC
Wuzzy
parents: 1434
diff changeset
     1
#summary Description of HWP files used to package custumizations of Hedgewars
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
     2
1435
1a8cc20ce16c HWPFormat: Add TOC
Wuzzy
parents: 1434
diff changeset
     3
= HWP files =
1a8cc20ce16c HWPFormat: Add TOC
Wuzzy
parents: 1434
diff changeset
     4
<wiki:toc max_depth="2" />
1a8cc20ce16c HWPFormat: Add TOC
Wuzzy
parents: 1434
diff changeset
     5
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
     6
== Introduction ==
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
     7
The HWP format provides a simple mechanism to package customizations of Hedgewars (maps, themes, sounds) in a single file. HWP files have the suffix “.hwp”. They are especially intended to be used to be shared online and to be installed rapidliy.
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
     8
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
     9
The file format provides an alternative to the “classical” method in which the user puts custom files directly into the user data directory.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    10
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    11
== Who uses HWP? ==
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    12
HWP files used in the “Downloadable Content” (DLC) section which can be accessed in the main-menu of Hedgewars or with your brower via [https://hedgewars.org/content.html]. Only HWP files are distributed there.
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    13
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    14
The community-driven Hedgewars addon server [http://hh.unit22.org/ hh.unit22.org] only accepts HWP files.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    15
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 548
diff changeset
    16
HWP files are also commonly used to distribute custom files in the [https://hedgewars.org/forum webforums].
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    17
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    18
HWP files are also used by a few scripts and missions, some of them even in the official game (see the section about sidecar HWPs).
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    19
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    20
== Using HWP ==
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    21
If you download any add-on from DLC, you must restart Hedgewars for the change to take effect.
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    22
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    23
To install a HWP file manually, just put it in the `Data/` subdirectory of your [https://www.hedgewars.org/node/6761 user directory].
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    24
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    25
== Creating simple HWPs ==
1435
1a8cc20ce16c HWPFormat: Add TOC
Wuzzy
parents: 1434
diff changeset
    26
Creating a HWP is easy. A HWP file is just a Zip file, but with the file name suffix “.hwp” instead of “.zip”. They reflect the content of the `Data/` directory of Hedgewars. Any file in a HWP will be treated as if it were in the `Data` directory.
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    27
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    28
=== Example ===
1438
e7214d0ff6e8 HWPFormat: HWP vs ZIP
Wuzzy
parents: 1437
diff changeset
    29
Suppose you have made a theme with the name “!MyTheme”, version 1 (`MyTheme_v1`). If you want to package it in a HWP, you just create a Zip file (e.g. “MyTheme_v1.zip”) with the following directory structure:
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    30
1432
549afbe978a8 HWPFormat: fix code section?
Wuzzy
parents: 1431
diff changeset
    31
{{{
1431
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    32
    Themes
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    33
        MyTheme_v1
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    34
            theme.cfg
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    35
            BlueWater.png
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    36
            SDWater.png
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    37
            horizont.png
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    38
            Sky.png
ea2c33d74c85 HWPFormat: fix indent?
Wuzzy
parents: 1430
diff changeset
    39
            (many other theme files)
1432
549afbe978a8 HWPFormat: fix code section?
Wuzzy
parents: 1431
diff changeset
    40
}}}
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    41
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    42
Then the only thing you need to do is to rename the Zip file to have the correct suffix, i.e. “MyTheme_v1.hwp”. Note only the suffix is important. The name before that can be whatever you like.
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    43
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    44
If you're done, you probably want to test it as well. Just put your fresh HWP into the `Data/` directory, restart Hedgewars and check if the theme shows up.
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    45
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    46
== Full description of HWPs ==
1434
83da47a13028 HWPFormat: Edited via web interface
Wuzzy
parents: 1433
diff changeset
    47
The section above explained all the basics you need to know about HWPs to get started.
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    48
1434
83da47a13028 HWPFormat: Edited via web interface
Wuzzy
parents: 1433
diff changeset
    49
HWPs have a couple of additional features which allow you to do more sophisticated things; you do not neet to understand these for packaging basic content like themes, maps, etc. This section explains the HWP files in greater detail.
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    50
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    51
=== Format specification ===
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    52
Technically, a HWP file is actually just a Zip file with an unusual file name suffix. The specification of HWP files itself is thus identical to the specification of Zip files.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    53
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    54
The complete Zip file format specification can be found at [http://www.pkware.com/documents/casestudies/APPNOTE.TXT].
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    55
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    56
=== How Hedgewars uses HWPs ===
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    57
All HWPs must have the file name suffix “.hwp” for Hedgewars to recognize it as such. This is a bit unusual, since the usual file name suffix for .ZIP files (which HWP files actually are) is “.zip”. Don’t worry about that, Hedgewars can cope with that.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    58
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    59
HWP files reflect the content of the `Data/` directory of Hedgewars. Therefore, the structure of the HWP file must be as if it were inside the `Data/` directory of Hedgewars and using the same directory tree.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    60
1139
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    61
HWP files will either add or replace a file. If there is no file with a identical name at the same sub-directory of `Data/`, then Hedgewars will simply add that file, making it available for Hedgewars. This is the most commonly used form of HWPs, used to create add-ons, like new missions, flag packs, themes, etc. If there is already a file with such a name there, Hedgewars will prefer the file in the HWP and ignore the other one. This has to be done with care, some files are safe to replace while other files cannot be simply replaced, as this will cause network games to fail. For example, if you have a HWP which replaces an object of a theme and you play that theme online, the online game will fail, unless your fellow players have the same HWP installed.
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    62
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    63
It is a special case when you have multiple HWPs activated, when some of them try to include a file with identical name. This is a conflict, see the conflict section for more information about this.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    64
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    65
==== Custom sprites and sounds ====
1140
38d6a4e430b5 HWPFormat: dummy sprites
Wuzzy
parents: 1139
diff changeset
    66
For Lua scripts you can add a few custom sounds and sprites without actually replacing any useful resources. For this, Hedgewars offers a 8 dummy sprites and 8 dummy sounds which only exist so they can be added in a HWP.
1139
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    67
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    68
The custom sprites are named `Graphics/custom1.png` to `Graphics/custom8.png` and are accessed in Lua with `sprCustom1` to `sprCustom8`.
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    69
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    70
The custom sounds are named `Sounds/custom1.ogg` to `Sounds/custom8.ogg` and are accessed in Lua with `sndCustom1` to `sndCustom8`.
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    71
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    72
==== Custom ammo icons ====
1139
8e932b5dcedd HWPFormat: Explain custom sprites and sounds
Wuzzy
parents: 995
diff changeset
    73
Overwriting ammo icons is a special case. If `Graphics/AmmoMenu/Ammos.png` or `Graphics/AmmoMenu/Ammos_bw.png` is found in the HWP, it will be overlayed over the original images `Graphics/AmmoMenu/Ammos_base.png` and `Graphics/AmmoMenu/Ammos_bw_base.png`, respectively. This is useful if you only need to replace a few certain ammo icons, and not the entire set of ammo icons. This is especially important to ensure forwards-compability of your sidecar HWPs for your scripts (see below).
994
587e1b18132d HWPFormat: Explain Ammos image overwrite
Wuzzy
parents: 960
diff changeset
    74
587e1b18132d HWPFormat: Explain Ammos image overwrite
Wuzzy
parents: 960
diff changeset
    75
For example, if you want to replace the “Air Attack” icon with a crosshair icon, but leave everything else alone, just draw the cross hair icon on the correct position and make all other frames fully transparent.
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    76
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    77
== Possible locations for HWPs ==
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    78
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    79
=== HWPs in `Data/` ===
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    80
The most common HWPs will be stored in the `Data/` directory of Hedgewars. Note that there are two `Data/` directories for Hedgewars, one is system-wide and one is intended for the current user. In case of conflicts between both, the user directory will take precendence.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    81
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    82
Storing HWPs in the user `Data/` directory is the most common form of installing a HWP to Hedgewars. This is what happens when you use DLCs. HWPs distributed in webforums are usually intended to be installed into the user `Data/` directory.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    83
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    84
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    85
=== Sidecar HWPs ===
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    86
Sidecar HWPs are HWPs installed in the same directory as a Lua script. Sidecar HWPs always serve as a companion for one single Lua script. Sidecar HWPs will be activated only if the script in question is run by Hedgewars. Otherwise, the HWP remains inactive and its resources are unavailable.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    87
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    88
The name of a sidecar HWP equals the name of the Lua script it serves as a “sidecar”, with the file name suffix replaced by “.hwp”. Sidecar HWPs must be in the same directory as the script.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    89
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    90
Example: The sidecar HWP of the Lua script in `/Data/Missions/Training/MyAwesomeMission.lua` would be `Data/Missions/Training/MyAwesomeMission.hwp`.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    91
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    92
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.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
    93
995
84089099197f HWPFormat: Refer in sidecar section to ammo icons
Wuzzy
parents: 994
diff changeset
    94
Please remember how Hedgewars uses ammo icons in HWPs (see above).
84089099197f HWPFormat: Refer in sidecar section to ammo icons
Wuzzy
parents: 994
diff changeset
    95
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
    96
=== Limitations ===
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
    97
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.
959
b167ea1e5563 HWPFormat: Add warning about non-recursivity
Wuzzy
parents: 798
diff changeset
    98
b167ea1e5563 HWPFormat: Add warning about non-recursivity
Wuzzy
parents: 798
diff changeset
    99
This is considered a bug, see https://issues.hedgewars.org/show_bug.cgi?id=174.
b167ea1e5563 HWPFormat: Add warning about non-recursivity
Wuzzy
parents: 798
diff changeset
   100
1433
19945dc3944e HWPFormat: simplify headers
Wuzzy
parents: 1432
diff changeset
   101
=== Order of precedence ===
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   102
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   103
  # Sidecar HWPs
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   104
  # All HWPs
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   105
  # Alphabetically
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   106
  # User `Data/` directory
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   107
  # System `Data/` directory (usually when no HWP file is found)
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   108
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   109
1429
801df24921d6 HWPFormat: Add a short description for ease-of-use
Wuzzy
parents: 1140
diff changeset
   110
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   111
== Best practices ==
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   112
This section has a couple of conventions which are considered to be best practices when creating HWP files. They are not mandatory, just recommendations.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   113
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   114
=== Versioning ===
1436
6579d83e42c4 HWPFormat: Versioning update
Wuzzy
parents: 1435
diff changeset
   115
For maps, themes, forts and any scripted content, we suggest to use a naming convention. The convention for those is to include a simple versioning into the file name. The syntax of this convention is this:
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   116
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   117
<code>FileName_v<number>.hwp</code>
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   118
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   119
Where `<number>` is replaced with an integer for the version number, starting by 1. For each subsequent version, this number would be increased.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   120
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   121
Example of three versions of a HWP file in the order they got released:
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   122
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   123
 * `MyAwesomePack_v1.hwp`
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   124
 * `MyAwesomePack_v2.hwp`
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   125
 * `MyAwesomePack_v3.hwp`
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   126
 * and so on …
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   127
1436
6579d83e42c4 HWPFormat: Versioning update
Wuzzy
parents: 1435
diff changeset
   128
Don't worry, the appended version number is generally understood to be *not* part of the real name. It's just an useful convention to help resolving possible conflicts in online play.
6579d83e42c4 HWPFormat: Versioning update
Wuzzy
parents: 1435
diff changeset
   129
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   130
== Possible problems, conflicts and security risks ==
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   131
Using HWP is not without problems.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   132
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   133
=== Security risks ===
546
507162614281 Rewritten the security section. I hope it is slightly better now.
almikes@aol.com
parents: 545
diff changeset
   134
Since HWP files can also include Lua files, there is the danger that someone may trick you into installing a HWP containing a malicious Lua script. Theoretically Lua scripts should not be able to directly write into any files, especially outside of the Hedgewars `Data/` directory. But security has not been intensively tested and there is always the risk of security vulnerabilities in Hedgewars itself.
507162614281 Rewritten the security section. I hope it is slightly better now.
almikes@aol.com
parents: 545
diff changeset
   135
507162614281 Rewritten the security section. I hope it is slightly better now.
almikes@aol.com
parents: 545
diff changeset
   136
Another potential risk are PNG files which contain a virus.
507162614281 Rewritten the security section. I hope it is slightly better now.
almikes@aol.com
parents: 545
diff changeset
   137
507162614281 Rewritten the security section. I hope it is slightly better now.
almikes@aol.com
parents: 545
diff changeset
   138
The only thing we can say now is that you should not blindly trust random users giving you HWP files. We recommend you to only use HWPs from sources you trust. When in doubt, check the contents of a HWP file by yourself by using your favourite Zip program, or don't install the HWP at all.
479
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   139
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   140
=== Conflicts ===
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   141
Conflicts happen if there are multiple active HWPs which provide a file with an identical name. Hedgewars will resolve those conflicts silently by using the order or precedence (see above), but this behaviour may still have unexpected effects, since the other file from the other HWP file becomes “invisible”. It is a good idea to check your installed HWP files for any “garbage” from time to time and delete those you don’t need.
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   142
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   143
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   144
Here is an incomplete list of things which you can safely replace and still play over network without problems:
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   145
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   146
 * Hats
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   147
 * Graves
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   148
 * Death animation
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   149
 * For themes:
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   150
  * clouds
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   151
  * chunks
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   152
  * music
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   153
  * waves
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   154
  * water colour
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   155
  * flakes
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   156
  * dust
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   157
  * mudball
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   158
  * splashes
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   159
  * landtex
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   160
  * landbacktex
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   161
  * sky
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   162
  * horizont
74942b51d806 Add description of the HWP format. Maybe not perfect or complete, but a very important start.
almikes@aol.com
parents:
diff changeset
   163
  * damage color
544
6e78f17e8328 Updated conflicts section (desync on overwritten sprites when placing them)
almikes@aol.com
parents: 492
diff changeset
   164
  * border
6e78f17e8328 Updated conflicts section (desync on overwritten sprites when placing them)
almikes@aol.com
parents: 492
diff changeset
   165
6e78f17e8328 Updated conflicts section (desync on overwritten sprites when placing them)
almikes@aol.com
parents: 492
diff changeset
   166
There is, however, an exception to this rule: Overwritten sprites which are placed by Lua scripts as land (i.e. with `PlaceSprite`) will cause a desynchronization in online games.