mangad / hf-workshop

Hero Fighter Workshop is a program for replacing stages, sounds, images and some data in the Hero Fighter game.

Hero Fighter Workshop is a program for replacing stages, sounds, images and some data in Hero Fighter. The game's stages are written in XML format, which HF can interpret. Data files are exported in JSON format, converted from AMF format, and some also include PNG files.

Download & User Guide

• HF Workshop
• HF & Tools

Build

See documentation/BUILD.md.

Methodology

See documentation/METHODOLOGY.md.

Contributing

See documentation/CONTRIBUTING.md.

Documentation

Documentation is generated using Doxygen (and doxywizard). Needs code review.

Copyright

Copyright (c) 2018-2021 David Gonçalves

License

This project uses the MIT license.

Third-Party Libraries

Project	Author(s)	License	Comments
rlutil	Tapio Vierros	WTFPL-2.0	Used for cross-platform console coloured text.
zlib	Jean-loup Gailly (compression) and Mark Adler (decompression)	zlib	Used for compressing and decompressing AMF data.
minizip	Gilles Vollant	zlib	Used for exporting / importing character data files in a zip file. It uses the zlib library.
GNU Readline	Original by Brian Fox and maintained by Chet Ramey	GPL-3	Not in use. Alternative for editline. Used for console input auto-complete, input history, input shortcuts. Uses the termcap library (GPL-2.0) on Windows.
Editline	Jess Thrysoee	BSD 3-Clause	Used for console input auto-complete, input history, input shortcuts. Alternative to GNU Readline. Depends on libncurses X11 License.
WinEditLine	Paolo Tosco	BSD 3-Clause	Editline equivalent for MinGW.
GNU gettext libintl	Original by Sun Microsystems, various developers.	LGPL-2.1	Used for internationalization and localization. On Windows uses iconv library (LGPL) and Expat library (MIT).
libswf	David Gonçalves	MIT License	Used for manipulating the SWF file. Makes use of 3rd-party libraries. Check its page for information on them and the respective licenses.

Table generated with: https://www.tablesgenerator.com/markdown_tables

A copy of the licenses can be found in documentation/additional_license_information.txt and must be distributed alongside the binary.

Credits

Hero Fighter is property of Marti Wong. HF Workshop was developed by MangaD as a tribute to the game and to keep it alive with many customizations possible in-game.

Project badge images created with https://shields.io/.