Random Avatar Plugin Readme

Overview

The Random Avatar plugin adds a webservice to Openfire, that can be used to obtain avatars from.

Installation

Copy randomavatar.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new randomavatar.jar file over the existing file.

Configuration

This plugin depends on HTTP binding, and will not work if the HTTP binding service of Openfire is disabled. It can be enabled on the Server > Server Settings > HTTP Binding page.

Using the Plugin

When properly configured, the web service will be made available on the same ports as the HTTP binding interface. By default, these URLs are:

Each request is normally responded to with an avatar-like image. Different images can be obtained, by adding text to the path of the URL, such as shown here:

https://<your-server-name>:7443/randomavatar/sometext.

Requesting the same URL will generate a response using the same image. It cannot be guaranteed that for different versions of this plugin the URL-to-image mapping will be the same.

Various different image collections are available. Currently, the plugin contains three collections:

By default, images are generated from the combination of all collections. To limit generation to one collection, append the name of the collection as a path segment, like this:

https://<your-server-name>:7443/randomavatar/kids/.

Adding more text to the path above will result in images just from that collection.

When a collection name is used that is not recognized, the plugin will return to its default behavior of returning an image from any of the available collections.

Attribution