tools/README.md
author sheepluva
Mon, 05 Aug 2019 00:20:45 +0200
changeset 15300 f382ec6dba11
parent 14166 fe5bfe70c3c2
permissions -rw-r--r--
In hindsight my emscripten-ifdef (70d416a8f63f) is nonsense. As fpcrtl_glShaderSource() would not be defined and lead to compiling issues. So either it's 3 ifdefs (in pas2cRedo, pas2cSystem and misc.c), in order to toggle between fpcrtl_ and the native function, or alternatively have no ifdef for it at all. I'm going with none at all, which means emscripten will compile with the original (const) function prototype, being wrapped by the fpcrtl_ function, same as non-emscripten builds.

# 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
* `check_engine_locale_files.sh`: Check the engine locale files for missing translations and problems
* `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)
* `check_translations.sh`: Check most translation files for mistakes and generate a simple progress report
* `find_outdated_engine_translations.sh`: Check for strings in engine translations that MIGHT be outdated

### 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