HWPFormat.wiki
changeset 1435 1a8cc20ce16c
parent 1434 83da47a13028
child 1436 6579d83e42c4
equal deleted inserted replaced
1434:83da47a13028 1435:1a8cc20ce16c
     1 #summary Description of the HWP format, used to package custumizations of Hedgewars
     1 #summary Description of HWP files used to package custumizations of Hedgewars
     2 
     2 
     3 = HWP format =
     3 = HWP files =
       
     4 <wiki:toc max_depth="2" />
       
     5 
     4 == Introduction ==
     6 == Introduction ==
     5 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.
     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.
     6 
     8 
     7 The file format provides an alternative to the “classical” method in which the user puts custom files directly into the user data directory.
     9 The file format provides an alternative to the “classical” method in which the user puts custom files directly into the user data directory.
     8 
    10 
    19 If you download any add-on from DLC, you must restart Hedgewars for the change to take effect.
    21 If you download any add-on from DLC, you must restart Hedgewars for the change to take effect.
    20 
    22 
    21 To install a HWP file manually, just put it in the `Data/` subdirectory of your [https://www.hedgewars.org/node/6761 user directory].
    23 To install a HWP file manually, just put it in the `Data/` subdirectory of your [https://www.hedgewars.org/node/6761 user directory].
    22 
    24 
    23 == Creating simple HWPs ==
    25 == Creating simple HWPs ==
    24 Creating a HWP is easy.
    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.
    25 
       
    26 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.
       
    27 
    27 
    28 === Example ===
    28 === Example ===
    29 Suppose you have made a theme with the name “!MyTheme_v1” (!MyTheme, version 1). If you want to package it in a HWP, you just create a Zip file (e.g. “MyTheme.zip”) with the following directory structure:
    29 Suppose you have made a theme with the name “!MyTheme_v1” (!MyTheme, version 1). If you want to package it in a HWP, you just create a Zip file (e.g. “MyTheme.zip”) with the following directory structure:
    30 
    30 
    31 {{{
    31 {{{