XenMoods Version 1.1.1 (22 Dec 2010)

[s0ct0j0c]

XenMoods

XenMoods is an add-on for XenForo that allows users to set their current mood.

Please read Shelley's helpful guide if your moods do not show up after installing.

Installation

1. To begin, upload all the files in the upload/ directory into your XenForo base directory (the one with library/ and styles/).
2. Next, go into your Admin Control Panel, and click Install Add-on.
3. Click the + Install Add-on button.
4. Select addon_xenmoods.xml as the file to upload.
5. Click Install Add-on to confirm the installation of XenMoods.
6. Perform the template edits as below.

Template Edits

The following template edits must be made to enable XenMoods to work correctly.

• Template: sidebar_visitor_panel

Find:

PHP:
<div class="stats">
<dl class="pairsJustified"><dt>{xen:phrase messages}:</dt> <dd>{xen:number $visitor.message_count}</dd></dl>
<dl class="pairsJustified"><dt>{xen:phrase likes}:</dt> <dd>{xen:number $visitor.like_count}</dd></dl>
<dl class="pairsJustified"><dt>{xen:phrase points}:</dt> <dd>{xen:number $visitor.trophy_points}</dd></dl>
</div>>

Add Below:

PHP:
<xen:if is="@sidebarShowMood">
<xen:include template="mood_display">
<xen:map from="$visitor" to="$user" />
</xen:include>
</xen:if>

• Template: member_card

Find

PHP:
<h3 class="username"><xen:username user="$user" class="NoOverlay" /></h3>

Add Below:

PHP:
<xen:if is="@memberCardShowMood">
<xen:include template="mood_display" />
</xen:if>

• Template: member_view

Find:

PHP:
<xen:if is="{$user.gender}">
<dt>{xen:phrase gender}:</dt>
<dd itemprop="gender"><xen:if is="{$user.gender} == 'male'">{xen:phrase male}<xen:else />{xen:phrase female}</xen:if></dd>
</xen:if>

Add Below:

PHP:
<xen:if is="@profileShowMood">
<dt>{xen:phrase mood}:</dt>
<dd><xen:include template="mood_display" /></dd>
</xen:if>

Display Locations

Moods are currently displayed in four locations which can be turned on or off through Style Properties (property location in parenthesis):

• Sidebar Visitor Panel (XenMoods, Show User Mood on Sidebar)
• Thread View (XenMoods, Show User Mood on Thread View)
• Member Card (XenMoods, Show User Mood on Member Card)
• Member Profile (XenMoods, Show User Mood on Profile)

Adding, Editing and Deleting Moods

The manager is located at admin.php?moods/. The link can be found in the left navigation bar when on the Admin Control Panel homepage.

The interface should be intuitive enough to work out. Enter image URLs as relative, e.g. styles/default/xenmoods/happy.png.

NB. You must have the Admin Permission Manage moods ticked.

User Permissions

You can set permissions for specific user groups as to whether they can see and have moods. The two permissions are View moods and Have moods.

Upgrading

1. Upload all the XenMoods files, overwriting any old ones.
2. Next, go to your Admin Control Panel homepage, and click List Add-ons or Manage Add-ons.
3. Activate the Controls drop-down for XenMoods, and click Upgrade.
4. Select addon_xenmoods.xml as the file to upload.
5. Click Upgrade Add-on to confirm.
6. Check your template edits to ensure they are up-to-date.

Uninstallation

If, for any reason, you would like to uninstall XenMoods, the following steps are necessary:

1. Undo the template edits that were performed on installation.
2. Go to your Admin Control Panel homepage, and click List Add-ons or Manage Add-ons.
3. Activate the Controls drop-down for XenMoods, and click Uninstall.
4. Remove all the files from XenForo (library/XenMoods/ and styles/default/xenmoods/).

Change Log

Version 1.1.1 (22 Dec 2010)

• Fix install bug if styles directory doesn't exist.
• Fix "Undefined offset" error on mood changes.
• Fix mood chooser hanging if not in overlay.

Version 1.1.0 (14 Dec 2010)

• Change moods with AJAX, fancy animations included.
• Publish mood changes into the news feed.
• Revise profile placement.
• Fix profile position margin issue.
• Fix tooltip alignment issue in certain situations.
• Various code improvements.

Version 1.0.4 (10 Dec 2010)

• XenForo 1.0.0 Beta 4 compatibility.
• Consolidate style properties.
• "Add New Mood" button added at bottom of moods list.
• Move thread view edits into template hooks.
• Updated other template edits.
• Various code improvements.

Version 1.0.3 (16 Oct 2010)

• Alphabetically sorted mood chooser.
• User profile mood positioning fix (redo member_view template edit).
• Fix mood chooser for differing mood image heights.
• Some code improvements.

Version 1.0.2 (15 Oct 2010)

• Centering of mood images in avatar holder.
• Add "No Mood" image (as default).
• Some code improvements.

Version 1.0.1 (10 Oct 2010)

• Add Shelley's moods.
• Scrolling Mood Chooser to manage overflow.
• Various code improvements.

Version 1.0.0 (9 Oct 2010)

• Initial release.