By Kostya and Yunivers
| Table of Contents | Description |
|---|---|
| What is CTFAK 2.0? | A short description of what CTFAK 2.0 is and what it's used for. |
| Installation | How to install a precompiled version of CTFAK 2.0. |
| Compilation | How to compile CTFAK 2.0 manually. |
| Usage | How to use CTFAK 2.0. |
| Parameters | All CTFAK 2.0 parameters. |
| Command Arguments | All CTFAK 2.0 command arguments. |
| To-Do List | What needs to be done to mark CTFAK 2.0 as complete. |
| Full Credits | Everyone who helped make CTFAK 2.0 a reality. |
CTFAK 2.0 (Standing for ClickTeam Fusion Army Knife 2.0) is a tool developed by Kostya with help from Yunivers which can be used to either decompile or dump assets of games made with the Clickteam Fusion 2.5 game engine.
With CTFAK 2.0's plugin system, it's easy for anyone to make a plugin compatible with CTFAK 2.0 which allows you to do anything with the data read by CTFAK 2.0 including, but not limited to, converting the data to other game engines, programming your own dumping method to suit however you want to organize your data, or messing with the outputted data by modifying the FTDecompile plugin.
CTFAK 2.0 is currently split between 3 branches; the master branch, the 2.3 branch, and the 2.4 branch.
USAGE OF 2.3 AND 2.4 IS NOT RECOMMENDED This README will only be referring to the 'master' branch, also known as CTFAK 2.2, which is the recommended version.
CTFAK 2.0 requires .NET 6.0's Runtime, Core Runtime, and Desktop Runtime.
After running the x64 installers for all 3 runtimes, you may proceed with the installation.
To install an artifact, you must be logged into a Github account, then you must make your way over to Actions, and from there select the latest workflow marked with the word master. On that page, if you scroll down you should find Artifacts, from there just click on CTFAK and it will start downloading.
Once it's downloaded, extract the .zip file to an empty folder, and then in those contents, extract ctfakrequirements.zip into the same folder it's found in.
To know you've extracted it properly, template.mfa should be found in the same folder as CTFAK.Cli.exe.
CTFAK 2.0 requires .NET 6.0's Runtime, Core Runtime, and Desktop Runtime.
After running the x64 installers for all 3 runtimes, you may proceed with the compilation.
Make sure you have Visual Studio 2022 installed and open.
On the GitHub branch, click Code and copy the HTTPS URL.
In Visual Studio 2022, under Get started, click Clone a repository, then paste the HTTPS URL from earlier. Input your desired path and press Clone.
Compiling CTFAK is not recommended. Please go to installation to download CTFAK precompiled.
Compiling CTFAK does not get you newer features compared to the actions.
If you'd like to compile CTFAK anyway, right click the solution on the right and press Build Solution or do it through the key bind Control + Shift + B, then right click the solution once again and press Open Folder in File Explorer.
In the File Explorer go to Interface\CTFAK.Cli\bin\Debug\net6.0-windows and create a folder called Plugins, then go back to the solution folder and browse into Plugins and in both CTFAK.Decompiler and Dumper, browse to bin\Debug\net6.0-windows, and copy CTFAK.Decompiler.dll, CTFAK.Decompiler.pdb, Dumper.dll, and Dumper.pdb then paste them into the Plugins folder you created earlier.
Finally, download ctfakrequirements.zip and extract the contents into the same folder you created Plugins in. To know you've extracted it properly, template.mfa should be found in the same folder as CTFAK.Cli.exe.
Now, you should be able to run CTFAK.Cli.exe without problems!
CTFAK 2.0 is very easy to use and requires little input from the user.
To get started, open CTFAK.Cli.exe and drag in your Clickteam Fusion 2.5 exe, apk, ccn, dat, bin, or mfa file and press enter.
In parameters, you can input anything listed in Parameters, but make sure to put a - before each one. If you don't want to input any parameters (which you normally shouldn't need to do) then you can leave it blank. After you've filled out your parameters, press enter.
If you're using a ccn, dat, or bin file it will bring up a prompt asking you to select a file reader. In any case, press 1 for CCN.
After these steps, it will start reading the application. If it closes or gives an error during this process, run CTFAK.Cli.exe in command prompt, repeat the process, and then send the error in our Discord or open an issue.
If all goes according to plan, you should see a screen saying Reading finished in _ seconds along with some information about the game. From here you may run any plugins you have installed. Normal installations should have Export as MFA, Dump Everything, Image Dumper, Sound Dumper, Packed Data Dumper, and Sorted Image Dumper.
If you run into any issues with those 6 plugins, you may send the error in our Discord or open an issue. If the plugin is not on that list, we cannot troubleshoot it for you.
Finally, you may close CTFAK 2.0 and find any outputs your plugins gave, in the Dumps folder.
All parameters should start with -.
| Parameter | Description |
|---|---|
| onlyimages | Prevents CTFAK 2.0 from reading any data unrelated to images. |
| noimg | Prevents CTFAK 2.0 from reading any images. |
| noevnt | Prevents CTFAK 2.0 from reading any events. |
| nosounds | Prevents CTFAK 2.0 from reading any sounds. |
| noalpha | Prevents CTFAK 2.0 from reading any alpha on images. |
| sorteddumpstrings | Has CTFAK 2.0 dump strings to text files alongside images in the Sorted Image Dumper. |
| srcexp | Forces CTFAK 2.0 to read a Source Explorer output. The unsorted output should be in a newly made ImageBank folder within your CTFAK 2.0 folder. |
| notrans | Prevents CTFAK 2.0 from applying Alpha, Color, or Shaders to objects. |
| noicons | Prevents CTFAK 2.0 from writing any object icons. |
| trace_chunks | Forces CTFAK 2.0 to write all chunks to CHUNK_TRACE. |
| dumpnewchunks | Forces CTFAK 2.0 to write chunks without a reader to UnkChunks. You must create this folder yourself. |
| f1.5 | Forces CTFAK 2.0 to read the input as MMF 1.5. |
| f3 | Forces CTFAK 2.0 to read the input as CTF 3.0. |
| android | Forces CTFAK 2.0 to read the input as android. |
| excludeframe([id]) | Forces CTFAK 2.0 to ignore the specified frame. ID indexes at 0. |
| log | Causes CTFAK 2.0 to log thread information about the Sorted Image Dumper. |
| badblend | Forces CTFAK 2.0 to revert to the old blend coeff fix. |
| chunk_info | Has CTFAK 2.0 log the size and offset of chunks. Also logs effects. |
These are command arguments for batch files or running CTFAK through cmd.
All arguments should start with - and should be followed up by data wrapped in quotations if data is required for said argument.
| Argument | Description |
|---|---|
| path | Automatically starts reading the inputted file path. |
| ____ | Leaving the arguments blank allows you to do the same thing as '-path'. |
| parameters | Allows you to input parameters that CTFAK 2.0 will read. |
| forcetype | Forces the kind of file type the file will be read as. Options: 'exe', 'apk', 'ccn', 'mfa' |
| tool | Uses the name of a plugin (such as 'Decompiler') to run said tool as soon as it's done reading. |
| closeonfinish | Closes CTFAK 2.0 after it finishes reading, or if you are using '-tool', after it finishes running the plugin. |
| % | Task | Description |
|---|---|---|
| 80% | MFA2Pame | Converting an MFA into the same format as an exe for easy dumping. |
| 0% | Native Lib to Linux | Allowing the native lib for CTFAK to run on Linux. |
| 1% | Klik & Play Support | Reading of applications made with Klik & Play. |
| 0% | TGF Support | Reading of applications made with The Games Factory. |
| 0% | TGF2 Support | Reading of applications made with The Games Factory 2. |
| 0% | MMF 1.0 Support | Reading of applications made with Click & Create. |
| 0% | MMF 1.5 Support | Reading of applications made with Multimedia Fusion. |
| 10% | MMF 2.0 Support | Reading of applications made with Multimedia Fusion 2. |
| 45% | CTF 3.0 Support | Reading of applications made with Clickteam Fusion 3. |
| Name | Credit for... |
|---|---|
| Mathias Kaerlev | Developer of Anaconda Mode 3. |
| Kostya | Developer of CTFAK and CTFAK 2.0. |
| Yunivers | Developer of CTFAK 2.0. |
| Slxdy | Assistant developer of CTFAK 2.0. |
| RED_EYE | Developer of the decryption library. |
| LAK132 | Coding help for the Image Bank rewrite. |
| Liz | Coding help for Child Events, Sub-App port. |
CTFAK 2.0 is licensed under AGPL-3.0.
Last Updated July 17th, 2023.