The Hack Tracking Log - it's here! (well, sorta)

[KuraFire]

You know vBHacker? That script system that would install hacks for you, generate installer files, and create text-install files?

Then think vBHacker. Now give that a boost very much like how vB2 got a huge boost and became vB3.

Now add some more cool stuff to what you have. There. You've got the Hack Tracking Log.

"Kura, that was so not descriptive at all. Come on, can't you explain this?"

Oh, you want more details? Allrighty, let's have 'm!

"What is the HTL?"
The Hack Tracking Log is an advanced system for maintaining all your vBulletin hacks. You use it to install and / or create hacks, and it will automate many processes for the Admin.

"What does the HTL do for us vB-admins?"
Well, it supports and aids you in the following things:
- Installing new Hacks;
- Running test runs (normal and verbose) for Hacks (does not modify anything)
- Creating (developing) new Hacks;
- Maintaining installed Hacks;
- Creating new menu items for Hacks that have them;
- Creating Template Groups for Hacks that have their own templates;
- Providing useful utilities and tips if you are creating a new Hack;
- (planned) Uninstalling Hacks;
- Generating Installer files and XML Files for when you want to release your Hack;
- Generating a prepared post that you can copy-paste when you release your Hack, if you want;
- Creating a front-end where your members can see which Hacks you have installed on the site. You can specify per hack if they are to appear in the front-end;


"Can you provide some visual explanation?"
Not descriptive enough? Then try out these screenshots! They're linked to instead of embedded because they total to 940~ kilobytes, and I reckon people will rather want to read this without being forced to download almost an MB worth of images. People with dialup anyway

Overview of installed Hacks
Add/Edit Hack page (currently showing Edit)
Make vB.org post (optional use of course)
Page with useful tips and utilities for creating Hacks

Edit Steps > overview page
Edit Steps > Edit XML files (phrases and templates)
Edit Steps > edit custom PHP code
Edit Steps > Edit Queries
Edit Steps > Edit Files and/or Templates page

Edit Instructions
Edit Menu Links

Installer Routine > Select Hack to install
Installer Routine > pre-install page
Installer Routine > Verbose Test run > import phrases
Installer Routine > Verbose Test run > import templates
Installer Routine > File Edits

Front-end > overview
Front-end > hack details

"Why manual file edits and not automated ones?"
1) Because automated file edits require you to chmod your files.
2) Because far more people seem to want to do manual file edits instead (myself included).
Manual file edits will make you SEE what the code changes are, and help you understand how the Hack works. It shows you what all changes, and in many cases this will help you understand the code and its purpose(s).
Also, I prefer not to rely on a human-made script that automates file edits. If something goes wrong, I'd rather have done something wrong myself, then have the script mess up without me having ANY clue at all what I can do to fix it, or where it went wrong.
Also, many people don't want to CHMOD their files, so manual file edits seemed really evident to me.


"Why did you make the HTL?"
Well, I primarily made the Hack Tracking Log because I was sick of thousand-and-one different installation instructions/scripts for the vB2 hacks we have. One hackmaker would always use a .txt, the next would go for vBHacker files, the next would make some custom installer script, the next would use the Installer Script system that Bane and someone else (iirc) made for such things, etc. etc. etc.
I didn't like how each hack came with a different kind of instruction-set. I couldn't easily keep track of which Hacks I had installed and which not. Moreover, I couldn't really upgrade my site anymore. I just did not know where all I had made hacks, so I'd be lost if I upgraded.
Figuring that many others had the exact same problem and disgruntledness with vB2 Hacks, I set out to bring some order in this chaos. The Hack Tracking Log does exactly that.

"Are people forced to use it?"
No, of course not. But they are strongly advised to. Not really because I made this hack and would enjoy seeing many use it. But because I would love to install some vB3 Hacks made by others, but I will simply refuse to install any hack on vB3 that does not come in an HTL-installer file. Why? Because I want to know where and how to make my file changes, without having to store all install.txt files of all hacks in some folder on my harddrive (or online). I want to have ALL the instructions neatly together, in my database. Usable. Flexible. Clear and descriptive.

"What are the benefits of using the HTL over doing it `the old way`?"
First of all, the HTL only needs 3 minor file edits. These three edits then prevent you from ever having to edit admincp/index.php (for adding new Menu items, because the HTL will take care of that for you once you have it installed), or includes/adminfunctions_template.php (for Template Groups for your custom templates - again, the HTL will take care of that for you once you have it installed);
Secondly, the HTL will hold all necessary information for each hack - what file edits to make, what template edits, new files for a hack, new templates, which queries to run, what custom php code to execute... everything.;
Thirdly, the HTL provides two useful utilities for you: a phrases XML file generator, and a templates XML file generator. It also gives you some useful hints on how to create new vB3 hacks (which can Really save you a buttload of headaches and needless fidgeting in the Admin CP);
Fourthly, when you create a hack using the HTL, you can make use of features like the `Make vB.org Post` function, and the `Generate Installer` function, which makes a new .htl file for your hack, which others can instantly use to install your hack on their board using the Install Routine that is part of the HTL.

"I'm still not really convinced. This sounds like a lot more work...."
Well, let me assure you that it is not. The HTL is designed to make your life easier in every aspect, when it comes to vBulletin 3 Hacks.
It automates some of the small but tedious tasks that most (bigger) hacks require, allowing you to focus solely on your code for the Hack (and/or the queries, and/or templates, etc.) - no longer messing around with routine stuff that takes up a lot of time but is needed for each Hack nonetheless.
It also makes sure that you don't lose track of all the Hacks you've installed. So if you want to upgrade to the next version of vBulletin 3 once we get to that point, you can do so and then very easily re-apply the file changes so that all your Hacks work again, without forcing you to sift through many files on your HD, or threads on vb.org, in order to find all the details again. You've got everything on your own site, perfectly sorted and instantly usable after each Upgrade.

In short: using the Hack Tracking Log will organize all aspects of your vB3-Hacking life, whether you focus on creating hacks or only using them does not matter - it works for both


"I'm convinced, where can I get this?"
The Hack Tracking Log only works on vBulletin 3.0.0 RC1 and higher, so there's no point in me releasing it until RC1 comes out. Once RC1 is released, the Hack Tracking Log will be released here on vb.org. When all this happens is something I can't tell you, but it will be soon


- KuraFire
Developer of the Hack Tracking Log