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

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

Oh, and I want to thank Scott and Kier for their support and understanding whenever I nagged about parts of vB3 being annoying or malfunctioning when it came to Hacks. They've applied some changes that were _vitally_ important for the Hack Tracking Log to be able to work in the first place. Kudos guys, you've been of great help! :)

The users in #vBorg and #vBnl had to go through several layers of kura-poking too!

Can't wait kura for the rc1 release

Heehee, they only suffered my endless ranting, they didn't really aid in production :p

^_^

but I'm glad they didn't get so sick of it that they refused to let themselves be as enthusiastic about the HTL as they were when I showed it ot them, tonight :)

How selfish, keeping this all to your self. God knows how long till RC1 will be released :(

:drool: Cant wait to see it in action! :)

Yeah, I'm kinda bummed that it has to be RC1, but oh well. Some features of the HTL (most importantly: the installer routine) require RC1-files, and I wasn't allowed to distribute those along with the HTL so that people could start using it.

A shame, but oh well. Hopefully RC1 is nigh ^_^

/me drools

I can't wait Kura!

STATUS UPDATE:
The HTL was at 0.95 and I am currently making changes to make it become version 1.0 for when RC1 comes out (Late November, as is currently expected).

What's new in 1.0 compared to 0.95:
- It keeps track of absolutely everything now; settinggroups, installfiles, new/modified database tables and columns, hack prefix, and files necessary for the installation only;
- An 8th step was added to the Install Routine: Import Settings; was definitely a lacking feature when you look at it. The functionality is not built-in right now but it will be once the HTL goes 1.0 (I'm waiting for Scott's fixes to the settings functions from vB3 that are necessary for this);
- version 1.0 will have a menu item that takes you to a page which will list ALL file edits from all your installed hacks (one page per hack, to keep it sensible);
- more organized, easier to use Help, Tips, Utilities page with improved XML-file generators (so you can very easily produce the XML files of your Hack's phrases, templates and settings).
- bypass method for admins to see all hacks on the front-end, even those that aren't set to be visible there (admin-only feature).
- and more :)

/me drools more

[high]* KuraFire hands oricon a bucket[/high]

;)

Wow it looks great :P we just have to wait one month or so... i guess

Yeah pretty much. I plan to have it all finished and beta-tested before RC1, so that I can release it directly on the first day :)

Am the only one who does not sees a download link?

This is because it isn't released yet. If you had read it you would have realised that.

Not released until RC1 is.

Mist, you're so wise :o)

release it release it release it :) **slaps himself**

You'll have to wait like all of us.... no matter how much you brag Kura with.

You lie you lie you lie :'(

No I don't lie.... but if you do read my sig it may just may shed some kind of light on things

Lol true true. You know i was only messing about right? I wasnt trying to offend you or anything

Ehhh.... if I'd release it now, you couldn't use it :) You couldn't even install it :)

The HTL doesn't work on beta 7, it only works on RC1 (and above, unless something major changes). So releasing it would be of no use :p


Besides, I'm still busy with those last-minute additions and all, so it's gone back to being in a development state, now....

I'm looking forward to using this hack ... not to keep track of hacks but to build installers. :D

Hopefully, it will make things easier for all coders.

That's the plan :)

I can assure you that so far, it's aided me greatly in making hacks and maintaining it.

Wow man, this looks incredible so far.

But how have you coded it for RC1 if it's not even out yet?

Scott had fixed some bugs for me after Beta 7 that I found while developing this system. Some were so integral that development on the HTL could not continue without the fix for those bugs, so Scott gave me the entire fix (which was an RC1 fix at that time, but by now it'll be called a Gamma fix). That's why I'm running vB3 Beta 7+, I have some very big bugfixes that aren't yet part of Beta 7. Additionally, this whole ordeal causes the Hack Tracking Log to be only usable on Gamma or RC1, because
a) not everyone has the Gamma/RC1 bugfixes necessary for the HTL (about 5 of 'm so far, some not found in the Bug tracker), and
b) I'm not allowed to spread the bugfixes on my own so everyone else will have to wait till RC1.

I'll wait it shouldn't be much longer anyways :D

Thank you for these efforts. :)

You're most welcome :)

I've tried very hard to design the HTL in such a way that it provides a very usable 'vb-hacking standard' for everyone ranging from hacking n00b to hacking expert. So far, it's working out at that. ^_^

I just hope that others will find it just as useful as I do. :)

Oh I will :D Don't you worry about it Kura... hopefully my hacking skillz will improve in the process :p

:)

Here's hoping! ;)

Will this definetly get released when RC comes out? If thats the plan of course.

Hope it doesnt turn into one of them great hacks everyone wants, that then gets chucked away and never finished.

It may be a few days after the release of RC1, but I'm trying to get it ready for the first day. Worst case scenario, it is released somewhere mid-december. :)

Any update on this?

I agree. I'm very excited about this. So c'mon KuraFire! (And thanks for developing it!)

Since it took much longer than expected for jelsoft to finish vB3, development on the HTL was paused because I went on a holiday. During my holiday, of all times, they came out with the version I need (I think, not 100% sure yet, actually). Only now can I finish the development of the Hack Tracking Log and convert it to the latest version of vB and all that.

It won't take much longer, though I AM still on holiday right now, so don't expect too much before the 15th of January (when my holiday ends).

I was just about to post something here about it. Anyway, I hope you enjoy your holiday. When you get back RC2 if not Gold will be here. This hack will really help me get organized ;)

Definitely, thanks :)

I've been adding some new functions as well, making the HTL even more useful for every vB3-admin who wishes to apply Hacks to his/her site. Also, once vB3 upgrades to 3.1 or whatever, the HTL will be really useful if you already have a lot of Hacks installed, as it will list all your (htl) hacks' necessary File Edits. :)

Great! I was thinking what would be better is if it edited the files for us lazy people but then, of course, code changes. Keep with the updates so we can all drool ;)