Introduction

HF Workshop is a tool that aims to allow editing HF data. This includes images, sounds, stage files, character data and background data. At the moment of this writing, there is only a console version, very basic, but does the job. There are no tutorials yet, I leave this task to you. The program has not been extensively tested yet so there may be latent bugs, please report any that you find (and make sure it is not your fault).

Please note that with great power comes great responsibility. There are two important things that you must have in consideration if you do not wish to harm the game and its author:

1. Hero Fighter has premium account. With data changing it is eventually possible to play with premium characters without buying them. However, keep in mind that the game's future depends on the support that it gets, that means popularity and income. Therefore, you shall not use your powers to unlock premium characters for everyone.
   
   If you really wish to support the game, you can replace premium characters with characters that you make, in order to encourage players to buy premium. But this is not necessary of course.
   
   Now you may ask if I'm not being an hypocrite, since I'm giving people the power to play with premium characters without buying them. But after much thought and consideration, I believe that what I'm doing helps the game more than it harms. That is because the game barely has any new player population at this moment, and continuing abandoned as it is, the future doesn't look bright. In other words, people are not buying premium. With all these new tools, the game at least has a chance to make a comeback and who knows new players may join and support the game.
   
   
2. Copyrighted content. Please do not make public any mods that contain copyrighted content (sounds, images...). This could get us into trouble if you share them here. Make sure that you only use free sounds and pictures in your modifications.
   

Another thing to consider is that your mods will be uploaded and downloaded on the internet, so you should resize / compress your sounds, images and executables as much as possible for smaller file sizes.


Story editing

Story editing is a whole chapter of its own and has its own forum here. With the release of HF Workshop, the HF Story Editor program becomes obsolete. There are 2 major reasons for this:

1. HF Workshop allows replacing stories, sounds, pictures, characters and backgrounds, whilst HFSE only allows replacing stories.
   
2. HFSE is heavy on resources and its interface not very useful. That is because HFSE was programmed in NodeJS and also uses Electron. Its interface only features a basic editor which isn't any better than editors such as Notepad++.
   

Stories are created using XML format and tutorials can be found in its due forum.

Sound editing

Only MP3 files are allowed, and only sample rates of 5512 Hz, 11025 Hz, 22050 Hz and 44100 Hz (note: sample rates and bit rates are not the same thing). HF Workshop will tell you if the MP3 file that you're trying to replace with doesn't meet the requirements. In this case, you may find a converter online for your MP3 file. It is also recommended that you find an MP3 compressor to reduce the size of your MP3 files.

Image editing

Only PNG files are supported. It is recommended that you resize and compress your PNG files.

Note: Images get slightly changed during the process of extracting and replacing because of premultiplied alpha.

Data editing

I don't have any tutorials on this but here's what you have to keep in mind:

1. Don't change the names of the extracted zip files and files inside the zip files if you wish to use them to replace data. That is because the program verifies if you're replacing the right data file ID (and corresponding name), and also expects the file names inside the zip to be in a specific format so it knows how to replace them.
   
2. Data values are in JSON format. Be careful with what you change in them because you can break the game completely.
   
3. The numbers in the file names specify their order and should not be changed. The exception is for PNG files in LMI data, in case you add or remove PNG files, make sure they correspond to an existing LimbPic JSON file.
   

Exporting EXE

You may export the modified Hero Fighter in SWF or EXE formats. When exporting, you'll be given the option to compress the SWF file using Zlib or LZMA algorithms. It is highly recommended that you use one of these because a smaller file size will be easier to transfer on the internet. Zlib compression is the most common, whilst LZMA is more recent and won't work on Flash Player versions below 11.

If you're using a Flash Player projector (i.e. an EXE file) it is recommended that you compress it using UPX.

Last but not least, not all HF exe files work with HF Workshop. The official HF exe from HF installer won't work. The HF portable exe file provided at this site before won't work either. So it is recommended that you use the new HF exe provided here.

Translating HFW

You may find it useful to translate HFW's interface to your native language in case your community doesn't know English very well.

1. Download this file.
   
2. Open the file with notepad++ and change the language code.
   
3. Open the PO file with Poedit and add the translated strings. If you open the PO file with a text editor, don't change the `msgid`s, change only the `msgstr`s! Make sure that the file is saved with UTF-8 encoding. Open it with notepad++ and convert the encoding to UTF-8 w/o BOM.
   

Change log


Thanks

• @Tommy for 'zh_TW' translation, assisting on early HFW development and testing.
  
• @O n L y for 'zh' and 'zh_TW' translation and testing.
  
• @Luigi600 for 'de' translation and testing.