Help File

1.   Disclaimer
This program and all libraries included with it are provided free of charge and for educational and testing purposes only. You may not use any of this program or any files included with it to commit any action which is illegal in the United States or where you reside.

This program is licensed under the Mozilla Public License (MPL), with some parts under different licenses, includeing the GNU General Public License (GPL), Microsoft Public License (Ms-PL) and MIT License. See the source code repository and the relevant LICENSE files in it for details.

2.   HaRepacker
A. System Requirements:
.NET Framework 4.5.1
Visual C++ Redistributable Packages for Visual Studio 2013

B.Shortcut Keys:
Delete – delete all currently selected nodes
Ctrl+C\Ctrl+V – copy\paste
Ctrl+F – show the search bar

C. WZ Serialization (aka dumping & importing):
HaRepacker 4 provides a few different methods for serializing WZ data. Most of them can also be deserialized (returned to WZ data form). Additionally, most methods can be performed either on the selected nodes or on a group of not-yet-loaded files. When using the second option, it is important to make sure the file is NOT loaded into HaRepacker yet.

Serialization methods:
* XML –> Private server XML: Separate XML files intended to be used inside an OdinMS based server’s WZ directory. It can only serialize WZ files, directories or images. WZ directories and files turn into actual directories, while WZ images turn into XML files. This type of XML cannot be deserialized back to WZ form (aka imported)

* XML –> Classic: This serialization method works exactly like the previous one, but it includes png and sound data in the XML and therefore can be deserialized. Since this type of XML has all the information the previous one has, it can also be used inside a server’s WZ directory (however, this is not a recommended practice because this type of XMLs take a lot of space).

* XML –> New: This is the new type of serialization into XML, which was only partially available in the previous versions. This serialization method only works with HaRepacker and is intended purely for information storage. This serialization method will export any amount of WZ properties, images or directories into a single XML file. The only data it cannot serialize is List.wz data. This type of XML can be deserialized.

* PNG\MP3: Dumps only the PNG and MP3 data to disk. WZ directories and images turn into real directories, and all PNGs and MP3 files are saved to their image’s directory. Cannot be deserialized.

* IMG Files: Dumps the WZ images into *.img files. This method can only serialize WZ files, directories and images, can be deserialized and is  the recommended method of dumping and storing information as it is the fastest, most compact and most memory efficient serialization method. When an IMG file is deserialized, the file is left open and cannot be moved, changed, renamed or deleted until the WZ file holding the image is closed.

3.   HaCreator
A. System Requirements:
.NET Framework 4.5.1
Visual C++ Redistributable Packages for Visual Studio 2013

B.Shortcut Keys:
Left mouse button – select objects (either from map or from the objects panel)
Right mouse button – release selected objects (while adding items from the objects panel), show the menu (when used on existing objects), edit map options (when used on the map tab)
Double click – new foothold anchor (while adding footholds), show instance editor (when used on existing objects)
Escape – deselect everything
Arrow Keys – move selected items
Ctrl+F – flip item
Ctrl+A – select all
Ctrl+Z\Y – undo\redo
Numpad +\- – increase\decrease Z value
Ctrl+C\V – Copy\Paste
Ctrl+S – Save to HAM file
Ctrl+O – Open another map