This How-To is mainly meant for Hack-Developers, if you are only planning to use Hacks just read the End-User section.
Developers
vBulletin 3.5.0 RC1 introduces a new concept for customizing/modifying vBulletin: Products.
With Products, you can manage Plugins, Phrases, Settings and Templates in just one XML File.
Furthermore it supports Install/Uninstall Codes (for running queries, etc.), it also covers updating existing Hacks as you can add Codes for different Versions.
To start, you first have to turn on debug mode:
Put
PHP Code:
$config['Misc']['debug'] = true;
in config.php.
Then go to ACP / Plugin System / Manage Products.
Click Add/Import Product.
In the second Form (Add New Product) fill in the Details for your Hack:
Product ID should be a unique ID for you Hack; it must not start with vb and should be lowercase only, not contain spaces or other special characters. Attention: The Product ID must not be longer then 15 characters.
Title should be the Title for your Hack
Version should be the Version.
The Format shoud be Mainversion Subversion Subrelease
Example: Myhack 1.0.0 Beta 1
Description should be a short description for you Hack, eg. what it does.
Afterwards, create all the Plugins, Phrases, Templates and Settings your Hack requires and make sure you select the Product you just created. Important: Templates must be placed in the MASTER Style, Phrases in the MASTER Language
When you are finished, go to ACP / Plugin System / Manage Products and select Edit from the Dropdown next to your Product.
In the Form (Add New Install/Uninstall Code) add all Code necessary to install/uninstall your Hack (eg, Queries, etc.).
If you are updating an existing Hack, add new Install/Uninstall Codes for the new Version that just make the changes necessary to upgrade the previous Version; Product Management will make sure that all necessary Codes will be run.
If your Hack includes Usergroup Permissions/Bitfields, add the following Code to Install and Uninstall to rebuild the Bitfield cache:
PHP Code:
if (is_newer_version('3.5.1', $vbulletin->options['templateversion']))
{
// Rebuild Bitfields
// Do this for vBulletin < 3.5.1 *ONLY*; later versions rebuild
// automatically and calling the builder in install code causes
// the bitfields NOT to be rebuild correctly
require_once(DIR . '/includes/class_bitfield_builder.php');
vB_Bitfield_Builder::save($db);
build_forum_permissions();
}
When everything is done, go to ACP / Plugin System / Manage Products again and export the Product as XML; this will then include all Plugins, Templates, Phrases, Settings and Install/Uninstall Codes required.
End-Users
Go to ACP / Plugin System / Manage Products.
Click Add/Import Product, select the product XML File for the Hack you want to install.
If you are upgrading an existing Hack, make sure that Allow Overwrite is set to Yes
This How-To is (C) 2005 by KirbyDE and you are not allowed to redistribute it in any way without my explicit consent.
I have already fiound some errors/differences with that xml that I had. I have just set-up a test forum (we just moved server) so I am not so leary of playing now. With debug mode operational I have found varying things that I hadn't before.
Still digging!
I find it far easier to edit/programme on my desktop and can read the xml quite readily so no real problem there, each to his/her own I suppose :
I've set up a very small, but useful, plugin for my 3.6.8, and now processing it to be a product. It needs an upload of a .js file into the clientscript folder, but it also needs to add a single line into the headinclude template (basically the <script src> tag for the new uploaded .js file).
Is there a way to append to an existing template in the product xml file and, if so, can anyone clarify the command(s)?
If not, does anyone know of a related hook that I can use, so that I can just add this tag content onto the headinclude template?
Im new to this and have managed to alter the database when I load the xml file, but how can I add more information to the file, cause all I see is install and uninstall code areas. What about the hooks, do I have to make another xml file for that or can I include all in one ?
07-25-2005, 10:00 PM
03-01-2007, 10:24 PM
