Customizing PointsMod

Starting from version 1.1, (Poster's Licence) PointsMod can use a modular system to modify it's look.

Currently (PointsMod 1.2) this is supported for:

points display in Profile display
points display in posts
modify points dialog

The .pm_gauge -modular system

This system allows you to customize your profile display for PointsMod. You create new files with the extension ".pm_gauge" and store them into your Sources directory, and PointsMod can then load the custom settings into your YaBB board. You must enable the module for it to work!

ENABLING MODULES

The graphics modules can be enabled by selecting (in Forum Preferences & Settings):
1) Set "Select profile page display type:" to "Custom"
2) Set "Select "Custom"-mode gauge file:" to the name of the Module you wish to activate.

USING THE INCLUDED MODULE

The PointsMod package includes on pre-packaged module, the "cards.pm_gauge".

CARDS.PM_GAUGE: Defines "football cards" style system, which can be used in:

Profile display
points display under avatars
modify points dialog

When loaded, cards.pm_gauge requires the following additional settings:

Select user points indicator type (in posts): "Custom"
Users start with: 1 points
Maximum amount of points is: 1 points

You may also wish to modify the following settings:

How many days to gain one point while point count is negative? _ days (This defines how long a Red Card stays when given!)
How many days to gain one point while point count is positive? _ days (This defines how long it takes for an Orange Card to become Green.)
Poster's licence points count for auto warning at: _ points

THE .pm_gauge SETTINGS FORMAT

Each .pm_gauge file is actually a Perl file that sets values for certain variables (settings) utilized by PointsMod. The settings format uses the following variables:

Variable name: Purpose:

$pm_custom_images_type Defines whether the images should be loaded by percentage or by exact points values. Used in the Profile page.

%pm_custom_images Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Profile page.

$pm_custom_implements_link_to_offenseslist Defines whether a link to the Offenses List should be appended. Used in the Profile page.

$pm_custom_modify_type Defines whether the images should be loaded by percentage or by exact points values. Used in the Modify Points page.

%pm_custom_modify Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Modify Points page.

$pm_custom_modify_system Contains all the HTML shown when points are modified. Used in the Modify Points page.

$pm_custom_modify_name_type Defines whether description texts should be loaded by percentage or by exact points values. Used in the Posts page, and replaces "(+x points)" with something appropriate such as "(Red card given!!)".

%pm_custom_modify_name Contains description texts for posts, indexed either by percentage or by exact points values. Used in the Posts page.

$pm_custom_post_display_type Defines whether the images should be loaded by percentage or by exact points values. Used in the Posts page.

%pm_custom_post_display Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Posts page.

Note that for the file to work, the last line must be:
1; # do not remove this line!!

EXAMPLES & REFERENCE

$pm_custom_images_type:	Defines whether the images should be loaded by percentage or by exact points values. Used in the Profile page.
Valid values:	'e' or '%'
Example:	$pm_custom_images_type = 'e';

%pm_custom_images:	Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Profile page.
Valid indexing:	'=[number]e' and '<0e' OR '=[number]%' and '<0%'
Examples:	Example 1: %pm_custom_images = ('<30%' => qq~image for below 30%~, '<60%' => qq~image for below 60%~, '<100%' => qq~image for below 100%~); Example 2: %pm_custom_images = ('<0e' => qq~negative points count~, '=5e' => qq~image for points count 5 and below~, '=10e' => qq~image for points count 10 and below~);

$pm_custom_implements_link_to_offenseslist:	Defines whether a link to the Offenses List should be appended. Used in the Profile page.
Valid values:	1 or 0.
Example:	$pm_custom_implements_link_to_offenseslist = 0; #Append link to Custom images...

$pm_custom_modify_type:	Defines whether the images should be loaded by percentage or by exact points values. Used in the Modify Points page.
Valid values:	'e' or '%'
Example:	$pm_custom_modify_type = 'e';

%pm_custom_modify:	Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Modify Points page.
Valid indexing:	'=[number]e' and '<0e' OR '=[number]%' and '<0%'
Examples:	Example 1: %pm_custom_modify = ('<30%' => qq~image for below 30%~, '<60%' => qq~image for below 60%~, '<100%' => qq~image for below 100%~); Example 2: %pm_custom_modify = ('<0e' => qq~negative points count~, '=5e' => qq~image for points count 5 and below~, '=10e' => qq~image for points count 10 and below~);

$pm_custom_modify_system:	Defines whether a link to the Offenses List should be appended. Used in the Profile page.
Valid values:	Valid HTML.
Example:	$pm_custom_modify_system = qq~<input type="hidden" name="sign" value="$pointsmod{'71'}"> <input type="radio" name="amount" value="1" class="windowbg" bgcolor="$color{'windowbg'}">Set value to 1.<br> <input type="radio" name="amount" value="2" class="windowbg" bgcolor="$color{'windowbg'}">Set value to 2. ~;

$pm_custom_modify_name_type:	Defines whether description texts should be loaded by percentage or by exact points values. Used in the Posts page, and replaces "(+x points)" with something appropriate such as "(Red card given!!)".
Valid values:	'e' or '%'
Example:	$pm_custom_modify_name_type = 'e';

%pm_custom_modify_name:	Contains description texts for posts, indexed either by percentage or by exact points values. Used in the Posts page.
Valid indexing:	'=[number]e' and '<0e' OR '=[number]%' and '<0%'
Example:	%pm_custom_modify_name = ('<0e' => qq~Red card!!~, '=0e' => qq~Orange card!~, '=1e' => qq~Green card.~);

$pm_custom_post_display_type:	Defines whether the images should be loaded by percentage or by exact points values. Used in the Posts page.
Valid values:	'e' or '%'
Example:	$pm_custom_post_display_type = 'e';

%pm_custom_post_display:	Contains HTML for custom images, indexed either by percentage or by exact points values. Ussed in the Posts page.
Valid indexing:	'=[number]e' and '<0e' OR '=[number]%' and '<0%'
Examples:	Example 1: %pm_custom_post_display = ('<30%' => qq~image for below 30%~, '<60%' => qq~image for below 60%~, '<100%' => qq~image for below 100%~); Example 2: %pm_custom_post_display = ('<0e' => qq~negative points count~, '=5e' => qq~image for points count 5 and below~, '=10e' => qq~image for points count 10 and below~);

Variable name:	Purpose:
$pm_custom_images_type	Defines whether the images should be loaded by percentage or by exact points values. Used in the Profile page.
%pm_custom_images	Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Profile page.
$pm_custom_implements_link_to_offenseslist	Defines whether a link to the Offenses List should be appended. Used in the Profile page.
$pm_custom_modify_type	Defines whether the images should be loaded by percentage or by exact points values. Used in the Modify Points page.
%pm_custom_modify	Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Modify Points page.
$pm_custom_modify_system	Contains all the HTML shown when points are modified. Used in the Modify Points page.
$pm_custom_modify_name_type	Defines whether description texts should be loaded by percentage or by exact points values. Used in the Posts page, and replaces "(+x points)" with something appropriate such as "(Red card given!!)".
%pm_custom_modify_name	Contains description texts for posts, indexed either by percentage or by exact points values. Used in the Posts page.
$pm_custom_post_display_type	Defines whether the images should be loaded by percentage or by exact points values. Used in the Posts page.
%pm_custom_post_display	Contains HTML for custom images, indexed either by percentage or by exact points values. Used in the Posts page.