Home

Welcome to the XF-Badges Wiki!

Reward your users with collectible badges, and control how your users get them.

Automatic Installation (with .zip)

Upload .zip to your XenForo forum using the Install/upgrade from archive button in ACP:Addons (admin.php?add-ons).

Manual Installation Method

1. Download the desired version of the Addon.
2. Extract .zip contents.
3. Upload the contents of upload to the root folder of your XenForo Installation.
4. Navigate to your forums ACP.
5. Install [VersoBit] Badges in ACP:Addons (admin.php?add-ons).

Git Assisted Install/Upgrade (Dev Source as Addon)

This method allows you to checkout a copy of the repo from github and upgrade via command line. It is not recommended for production forums unless you follow version tags on master.

Use Latest Master Branch

1. Connect to your server via SSH
2. cd /path/to/xenforo/src/addons
3. git clone https://github.com/VersoBit/XF-Badges.git CMTV/Badges
4. Navigate to your forums ACP.
5. Install [VersoBit] Badges in ACP:Addons (admin.php?add-ons).

Use a Specific Version

1. Connect to your server via SSH
2. cd /path/to/xenforo/src/addons
3. git clone -b 'v2.0.0' https://github.com/VersoBit/XF-Badges.git CMTV/Badges
4. Navigate to your forums ACP.
5. Install [VersoBit] Badges in ACP:Addons (admin.php?add-ons).

Uninstall

1. Uninstall [VersoBit] Badges from ACP:Addons (admin.php?add-ons).
2. Navigate to /src/addons/CMTV (SSH/FTP/File Browser/etc).
3. Delete Badges folder.
4. (optional) If you do not have any other CMTV addons installed, you can also remove the CMTV folder in /src/addons

Getting Started

1. Configure the Global Settings in ACP:Options:[VersoBit] Badges (admin.php?add-ons/CMTV-Badges/options) [Wiki]

Additional Notes

As this project is developed further, the Wiki will be updated with additional guides. Please be patient :)