tools/README.md
author Wuzzy <Wuzzy2@mail.ru>
Tue, 21 Aug 2018 17:56:17 +0200
changeset 13680 d3a4cbba060e
parent 13516 b62b14aa88d4
child 13970 fa9b22311390
permissions -rw-r--r--
Consistently rename "team chat" to "clan chat" (except chat command) Only change in strings, no functional change. "Team" and "clan" have defined meanings in HW, but "team chat" oddly broke this convention. This feature allows chat with your clan, not with your team, so is now called "clan chat". /team command unchanged to avoid disruption (for now).

# tools/ directory

This directory contains various tools for HW development.

To learn more about each individual tool, open its source file in a text editor,
it often contains a brief comment at the top.

## List of tools (excerpt)

### Files
* `update_locale_files.sh`: Update locale files
* `hwmap2lua.sh`: Convert HWMAP files to Lua code for usage in missions
* `create_dmg.sh`: Generate a .dmg file (relevant for Mac)
* `dmg_pkg_install.sh`: Downloads and install a .dmg from a URL (relevant for Mac)
* `docgen.sh`: Generate QTfrontend documentation with Doxygen (it's not very good)

### Directories
* `hwmapconverter`: C++ application to edit HWMAP files in text form
* `pas2c`: Pascal-to-C rewriter. Used when hwengine is built as C application with `BUILD_ENGINE_C=1`
* `old`: Very outdated stuff that needs re-examination and possibly deletion