Error in mod installation

From Online Manual

Jump to: navigation, search

You have just tried to install a mod using the package manager and the screen indicates that the mod had several failures.

Always back up your forum files and database before applying any mods, especially if manual intervention is required. SMF has an automatic backup that creates files with the file extension .php~. This can be disabled, so it is always a good idea to make a manual backup.

An example of a failed attempt to install a mod correctly is shown below:

   1. Execute Modification    ./index.php    Test successful
   2. Execute Modification    ./Themes/default/BoardIndex.template.php    Test failed
       1. Add After    ./Themes/default/BoardIndex.template.php    Test successful
       2. Replace    ./Themes/default/BoardIndex.template.php    Test failed

This means that the code which the mod is attempting to find, in order to perform the modification instruction (add before, add after, or replace) has been changed, either by another mod, by the admin manually making changes to the code, or because the mod you are attempting to install is for a different version of the file(s).

You can still try to install the mod, but you will have to make changes manually to the "failed" files.

If your forum is version 2.0.x, you can click on the edit icon to the left of the instruction which failed. A pop-up will be generated indicating the specific instruction (the code being looked for and the code to be added or replace). Otherwise, you can use the parser on the page where you downloaded the mod.

Take note of these instructions (if there is more than one failure, copy each instruction to a text editor for later use.) and click the Install Now button. You will receive a warning that the mod will not fully install, click ok.

At this point, your mod is mostly installed (depending on the number of failures).

Using an FTP program or your site's file manager, open and edit the files in which the system had noted failures. You should use a proper text editor to edit the files, it is not recommended to use Word or Notepad as they can add unwanted extras to the files, using a program like Notepad++ is recommended.

Be Aware: The code which is listed in the mod instructions is not present in the exact form listed. If it were, the system would have been able to carry out the automatic instruction. This means that you will have to use some intuition to find the code which you are looking for. It may be as simple as a difference in leading spaces, or another mod may have already significantly altered the searched for lines.

Once you have found the correct section of code, perform the instruction Add before, Add after, or Replace. If the instruction is Replace, you will have to be careful because if another mod has already altered this section of code, simply replacing the code may cause errors in your previously installed mod(s).

Once you have edited the file with the appropriate code, save it, and, if using ftp, upload the altered file to your system.

See Also