Help: Mod Manager

Overview

The TNG Mod Manager, originally developed by Brian McFadyen and updated by Sean Schwoere to work with the Joomla TNG Component, is intended to provide a more integrated way to install, remove and manage modifications to the TNG software package that have been coded to work with this manager. Updates were made in TNG V9 by Bart Degryse and Ken Roy to prevent clean up attempts when the mod cannot be installed. The Mod Manager is connected into the TNG Administrative page for easy access. The Mod Manager adds the following folders to TNG:

  • mods to contain the Mod configuration files and associated Mod support files
  • extensions to contain some of the mod extensions that are installed by other Mod Manager config files

The Batch Updates was added by Rick Bisbee in TNG 10.0.3 to provide the capability to execute the same action against multiple mods. The Description popup was added by Jeff Robison.

The Options was added by Ken Roy in TNG 10.0.3 to allow changing some of the execution behavior of the Mod Manager.

The View Log was added by Ken Roy in TNG 10.0.3 to display the Mod Manager Log which is now split from the Admin Log. The Mod Manager log was reformated by Rick Bisbee for easier readability of the actions.

Additional information can be found in the Mod Manager article and in the TNG Mod Manager category of articles on the TNG Wiki.

Top

Operation

The Mod Manager examines the mods folder and reads each cfg file that it finds. The cfg files are directive files that describe the mod, the files and locations to be modified, and the code that is used in the modification.

The Mod Manager checks the following:

  • ensures the user is logged in
  • examines each code location and change
    • ensures the location can be found
    • ensures the target location is unique
    • identifies whether the target location has already been installed
  • identifies new files to be created. If the new file already exists, it examines the version level

Top

Status

The Mod Manager returns the following status:

  • Ok to Install if the mod is not yet installed and the target locations can be identified, then the Install button is displayed
  • Installed if the mod is completely installed, the option to Remove the Mod is presented and the option to Edit parameters if any exist
  • Clean Up if the mod is partially installed, the Cleanup button is provided. A Clean up operation will attempt to remove any inserted code, restore and replaced code, and remove any created or copied files.
  • Unable to Install if the mod cannot be installed. This message will be preceded by an other message that provides more details as to why the mod cannot be installed.

For examples of the Mod Manager Status screens and how to interpret the various statuses, see Mod Manager - Interpreting Status

Top

Mod Syntax

The Mod Manager syntax basically includes:

Header section that includes

  • Name - the name of the mod, wiki article and file name
  • Version - the version of the mod, where the first 3 period places represents the lowest TNG version to which the mod applies
  • Description - provides a brief description of the mod, the Mod Developer's name, and a URL link to the TNG Wiki article for the mod.

Target sections that specify the file that is the target of the change and includes the following directives

  • Location - that specifies the code location to be changed
  • Action keyword - that specifies whether to replace or insert code before or after the location

New File directives that create the file when the mod is installed

Copy File directives that copy the specified file to the TNG root (%copyfile) or to a subfolder (%copyfile2)

For detailed information on the Mod Manager Syntax, see Mod Manager Syntax

Top

Config Files

Installing Mods

The TNG Wiki provides information on using the Config Files to install the mods.

Interpreting Status

The TNG Wiki provides information on Interpreting Status.

Config File Syntax

The TNG Wiki provides information on the Config File Syntax.

Creating Config Files

The TNG Wiki provides information for the mod developers on the Creating Config Files.

Top

Batch Updates

The Batch Updates allows specific actions on multiple mods using the Select Filter. You must choose from the status filter list and click Go to display the available controls for the specific status selected. Note that Delete is not available for the Clean Up status, so you will need to use the normal Mod List to delete mods in Clean Up status, such as a prior version of the same mod.

The Select Filter options are:

  • All - displays all a list of all the .cfg files in the mods folder. When you select a specific status then Action buttons will become available
  • Ok to Install - displays a list of all the mods that can be
    • Installed based on your selections and clicking the Install button
    • Deleted from your mods folder based on your selections and clicking the Delete button
  • Installed - displays a list of all the mods that are currently installed that can be
    • Removed based on your selections and clicking the Remove button
  • Clean Up - displays a list of all the mods that can be
    • Cleaned up based on your selections and clicking the Clean Up button
  • Unable to Install - displays a list of all the mods that cannot be installed, either due to Bad Targets or Missing files, that can be
    • Deleted from your mods folder based on your selections and clicking the Delete button

Top

Options

The Options allows you to specify some of the Mod Manager behavior for the

Affected Files List Options

  • Show Affected Files List - allows you to select whether to dislay the Affected Files List in the Mod List tab. The default is Yes.
  • Show New Files in List - displays new files created by the mod. The default is Yes.
  • Show Files Copied in List - displays the files that are copied or copied to by the mod. The default is Yes.
  • Show List in Column - displays the Affected Files List in the column selected. It defaults to the Config File Name column.
  • Show List as - allows you to select whether you want the list as a Table or Comma Separated Values. It defaults to Table.
  • Show List in Batch Updates - allows you to select whether you want the list displayed in the More popup in Batch Updates. It defaults to Yes.

Mod Manager Log Options

  • Log Mod Manager Actions - allows you to select whether you want to log the Mod Manager confirmation and actions. The default is Yes.
  • Log File Name - allows you to specify the file name to be used for the Mod Manager log. The default is modmgrlog.txt.
  • Log Max lines - allows you to specify how many lines to keep in the log. The default is 2000.

Other Options

  • Sort Lists by - allows you to specify what column to sort the Mod List and Batch Updates. The default is Config File Name.
  • Bypass the Confirmations - allows you to specify whether you want to bypass the Confirmation screen display in the Mod List. The Confirmation is still written to the log if you select Yes. The default is No.
  • Bypass the Action Messages - allows you to specify whether you want to bypass the Action message screen display in the Mod List. The Action messages are still written to the log if you select Yes. The default is No.