1 # tools/ directory

     2 

     3 This directory contains various tools for HW development.

     4 

     5 To learn more about each individual tool, open its source file in a text editor,

     6 it often contains a brief comment at the top.

     7 

     8 ## List of tools (excerpt)

     9 

    10 ### Files

    11 * `update_locale_files.sh`: Update locale files

    12 * `check_engine_locale_files.sh`: Check the engine locale files for missing translations and problems

    13 * `hwmap2lua.sh`: Convert HWMAP files to Lua code for usage in missions

    14 * `create_dmg.sh`: Generate a .dmg file (relevant for Mac)

    15 * `dmg_pkg_install.sh`: Downloads and install a .dmg from a URL (relevant for Mac)

    16 * `docgen.sh`: Generate QTfrontend documentation with Doxygen (it's not very good)

    17 * `check_translations.sh`: Check most translation files for mistakes and generate a simple progress report

    18 * `find_outdated_engine_translations.sh`: Check for strings in engine translations that MIGHT be outdated

    19 

    20 ### Directories

    21 * `hwmapconverter`: C++ application to edit HWMAP files in text form

    22 * `pas2c`: Pascal-to-C rewriter. Used when hwengine is built as C application with `BUILD_ENGINE_C=1`

    23 * `old`: Very outdated stuff that needs re-examination and possibly deletion