1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.
  2. This forum has been archived. New threads and replies may not be made. All add-ons/resources that are active should be migrated to the Resource Manager. See this thread for more information.

How to Install an Add-on (basics)

Discussion in 'Tips and Guides [Archive]' started by Morgain, Nov 13, 2011.

  1. Morgain

    Morgain Well-Known Member

    Developers make beautiful mods for us. But some are accustomed to thinking on a high level so their instructions on how to get the add-on working do not include the very basic steps many of us need.

    So I made this little guide.

    How to Install an Add-On for XenForo
    For anyone who is not an expert!
    Do not panic that the instructions are quite long. This is because every little step is explained, with pictures. But do read through the first time you read it. It is easy to assume we know every detail when we do not.

    1. PREP: On your own computer -

    NOTE the URL of the thread where you found the Add-on.
    (Copy it from the Address bar of your browser – CTRL+A then CTRL+C,
    then Paste CTRL+V in your tracker document you’re using to keep notes on how you are making changes to your XF. Hint. you should have this tracker document.)

    CREATE a folder for the Add-on files to go, in your XF forums folder, called e.g. add-ons. Then each add-on you get has its own separate folder in this add-ons folder.
    pic1 foldersjpg.jpg
    Extra folders called Added Pages, ADDONS, and zips.
    You may prefer different names. Zips folder is useful at top level for downloading.​
    If you do not do this there can be files with similar names for different add-ons which get confused especially README. Worse the folder to upload, and the special .xml file you will need to do through your admincp, will get muddled among various add-ons files.​
    2. DOWNLOAD the zip file for this Add-on to your computer.
    (This zip file is normally at the BOTTOM of the description of the add-on.
    If there are any other links that look likely it is still a good idea to check at the bottom.)​

    (The example used in this tutorial is Fuhrmann’s Profile Tab Manager.)​
    3. EXTRACT the files using Winzip or a similar program.
    Place the extracted files in a subfolder of your add-ons folder.
    You should be able to locate this folder in Winzip before you click to extract.

    It is helpful at this point to read the README.txt text file, if you see one in the downloaded files.
    It will be inside the main folder you get but outside any UPLOAD folder.
    README text files are not comfortable to read as they require scrolling to the right a lot.
    To make this more comfortable copy and paste into a normal document -​
    Click the text/ press CTRL+A and CTRL+C to copy it all / then Paste (CTRL+V) in your normal word processor document to read it.

    4. UPLOAD the contents of the folder named Upload or UPLOAD.
    Most add-ons will tell you to upload their UPLOAD folder to the “Library” directory of your XF forums – but do check any instructions in case this add-on is an exception.

    IMPORTANT! 1) Do NOT upload the entire folder named UPLOAD!
    Have a look inside it. There will be one of two things.
    – Does the name of the subfolder inside the UPLOAD folder match one of the top level directories in your XF forums? (Most likely “Library.”) Then upload everything INSIDE this ‘Library’ folder on your computer to the ‘Library’ directory on your XF forums.
    There could be more than one of these matching subfolder X directory pairs. If so upload the contents of each dolder separately to its matching directory.
    – Is the next subfolder inside the UPLOAD folder called the name of the add-on? The instructions in the README file and/or on the forum post where you got it, will tell you where to put it. The destination is usually the ‘Library’ directory.​
    IMPORTANT! 2) These files MUST be uploaded in the structure you receive them.
    So upload a folder with all its subfolders inside it.​
    5. GO TO your admincp
    www.mysite.com/admin or www.mysite.com/forums/admin

    On the Home menu on the left click “Install Add-on.”
    6. BROWSE to the subfolder containing THIS Add-on, on your computer.
    You are using the Install from uploaded file:​

    (This is where having its own separate folder is REALLY helpful!)​

    In the browse window showing files on your computer
    CLICK the .xml file. (The file ending with .xml )


    In the admincp window online CLICK the “Install Add-on” button.


    The result may be instant.
    For a bigger Add-on you can just watch happily as the admin section rebuilds some of the files to include new additions.

    7. TO USE YOUR ADD-ON you may have instructions on where to start
    ~ in the README text file provided in the download.
    ~ or on the forum post where you downloaded the zip.

    If no instructions in either of those places, try admincp/ Options.
    Your new Add-on is often at the bottom of that list (scroll down).
    OR www.yoursite.com/forumxf/admin.php?options/

    Or your new add-on might appear as a section of another page menu.
    Try the tabs at the top of the admincp to see if anything new appears in one of their first level menus.

    8. ANY PROBLEMS contact the Add-on maker on the forum thread where you downloaded the zip file at step 1. You noted this URL in step 1 (or you should have!)

    Remember this is unpaid or at best low paid work. Use a high level of politeness or human nature will dictate you get a response AFTER the polite people get theirs.

    It is considered fast if someone responds to you in 24 hours. You could try a second contact after 48 hours but not sooner.

    I cannot promise top be clever at answering any further questions but if I cannot I will find someone who can.
    rafass, goldcom, Aaron Sofaer and 4 others like this.
  2. Fuhrmann

    Fuhrmann Well-Known Member

    Thank you Morgain! Very helpful!
    Morgain likes this.
  3. Morgain

    Morgain Well-Known Member

    I thought maybe it would save time for developers to link to this. I have it in a document for attachment but I cannot upload it here.
    Fuhrmann likes this.
  4. steven s

    steven s Well-Known Member

  5. Morgain

    Morgain Well-Known Member

    Exactly Steven that's what I mean. Some of the devs say they are getting questions on what to do because some members need a more detailed baby steps instruction.
    iiTheWither likes this.
  6. erich37

    erich37 Well-Known Member

    so how to properly uninstall an Add-on ?
  7. Morgain

    Morgain Well-Known Member

    Erich you MIGHT get an answer to that here.
    But it would be better to post another thread in a forum which is about asking for support. I should think that would be quicker for you.
  8. Robbo

    Robbo Well-Known Member

    I'll start linking to this from my add-ons. Will make a few suggestions for changes to make it easier to follow later on.
    Fuhrmann and Morgain like this.
  9. LPH

    LPH Well-Known Member

    Thank you for this guide. I was running into a few challenges last night and this cleared up some of the steps.
    Morgain likes this.
  10. Edrondol

    Edrondol Well-Known Member

    Also note if you have a bunch of Styles on your site addons will take a bit of time to process. The OP says it could be instant, but not if you have a lot of styles.
  11. Deepmartini

    Deepmartini Well-Known Member

    This should be part of Xenforo's help section. Very well written!
  12. xen411

    xen411 New Member

    this is exactly what i needed to learn today

Share This Page