SigGen

Latest revision as of 01:35, 28 June 2011

Important note: When you edit this page, you agree to release your contribution into the public domain. If you do not want this or can not do this because of license restrictions, please do not edit.

Languages:

English

Intro and Info

Signature/Avatar Generator AddOn for Roster

Download -> http://www.wowroster.net/downloads/?id=20
Support -> http://www.wowroster.net/forum38.html

Current version: 0.3.2.409
Documentation is for v0.3.0 and higher
Updated: 01:35, 28 June 2011 (UTC)
Author: Zanix

This is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. So if it blows up your server it's not my fault
These signatures/avatars can be used for web forums, they will show a character's level, membership, rank, trade skill levels, and other such information.

The information in these signature graphics will be as up to date as the information in roster.
This is very configurable, everything can be moved fairly easily, text colors can be changed, almost everything can be displayed/hidden

To configure, open /roster/index.php?rostercp-addon-siggen (SEO: /roster/rostercp/addon/siggen.html) in a web-browser

For members that haven't uploaded info, this will show limited information on a default background

Change Log

> SigGen Change Log

Thanks

All props to the original creator(s) of img.php

Note:

Ripped from the readme of img.php Code written by Tony Fontaine, aka Reolus, tonyfontaine@knightraven.net http://www.gnomishmarinecorps.com Inspired by the WoWSigCreator by Ashenfield ( ashenfield@gmail.com ) http://www.dizzarian.com

To everyone else that I haven't mentioned
And all those that have tested the previous versions; sig1.5 : sig2.0 : sig2.0-gamma : etc...

Requirements

WoWRoster v2.0.0 or higher
PHP 4.3.2 or better
GD2 with PNG and Freetype Support

Advanced functions in SigGen Config may not work if safe_mode is turned on in your PHP config file
SigGen absolutely requires that your PHP installation supports the GD2 library, and that GD2 has PNG Support and FreeType Support turned on
RosterDiag MUST SAY FreeType Support: yes for you to use SigGen

FreeType Linkage: with freetype is best although with TTF may work ok

If you have trouble with the signature generator, first check RosterDiag for information about how the GD2 library is configured (or not available) on your web server

If you DO NOT want SigGen, or if you cannot get GD2 to work on your server, you can un-install SigGen via RosterCP -> Addon Management, then delete the folder from the addons directory /addons/siggen/ and that will remove all traces of SigGen

File Structure

siggen/
 |_admin/
 |  |_index.php
 |_ava/ (default saved avatar folder)
 |_char/
 |  |_index.php
 |_img/
 |  |_background/
 |  |  |_defaultava/
 |  |  |  |_(*).png
 |  |  |_defaultsig/
 |  |  |  |_(*).png
 |  |  |_(Other Image Packs)/
 |  |_border/
 |  |  |_(*).png
 |  |_character/
 |  |  |_default/
 |  |  |  |_(*).png
 |  |  |_start/
 |  |  |  |_(*).png
 |  |  |_(Other Image Packs)/
 |  |  |  |_(*).png
 |  |_class/
 |  |  |_rounded/
 |  |  |  |_(*).png
 |  |  |_square/
 |  |  |  |_(*).png
 |  |  |_(Other Image Packs)/
 |  |  |  |_(*).png
 |  |_frame/
 |  |  |_(*).png
 |  |_level/
 |  |  |_(*).png
 |  |_members/ (default location for uploaded per-character images)
 |  |_pvp/
 |  |  |_default/
 |  |  |  |_(*).png
 |  |  |_(Other Image Packs)/
 |  |  |  |_(*).png
 |_inc/
 |  |_conf.php
 |  |_functions.inc
 |  |_install.def..php
 |  |_sql.inc
 |  |_update_hook.php (auto-save character image trigger file)
 |_locale/
 |  |_deDE.php
 |  |_enUS.php
 |  |_esES.php
 |  |_frFR.php
 |_sig/ (default saved signature folder)
 |_templates/
 |  |_(*).tpl
 |_changelog.txt
 |_index.php
 |_license.txt
 |_siggen.php (siggen generator code)
 |_style.css

Usage

After installing SigGen, you will find a SigGen button on the character panel that will preview the signature and avatar images for that character as well as provide dynamic link URLs for each.

So if your roster URL is http://www.yoursite.com/roster/

Dynamic links:

• Signature: http://www.yoursite.com/roster/index.php?p=util-siggen-signature&member=Name
• Avatar: http://www.yoursite.com/roster/index.php?p=util-siggen-avatar&member=Name

SEO - Friendly Links Mode:

• Signature: http://www.yoursite.com/roster/util/siggen/signature/member=Name.png
• Avatar: http://www.yoursite.com/roster/util/siggen/avatar/member=Name.png

To get the graphic for a character named "Bob", use:

• Signature:

  http://www.yoursite.com/roster/index.php?p=util-siggen-signature&member=Bob

  SEO: http://www.yoursite.com/roster/util/siggen/signature/member=Bob.png

• Avatar:

  http://www.yoursite.com/roster/index.php?p=util-siggen-avatar&member=Bob

  SEO: http://www.yoursite.com/roster/util/siggen/avatar/member=Bob.png

Now suppose you host multiple guilds or characters across multiple realms and there are characters with the same name.
You need to therefore be able to specify the realm in the URL to get the character of choice as follows:

• Signature:

  http://www.yoursite.com/roster/index.php?p=util-siggen-signature&member=Name@Realm

  SEO: http://www.yoursite.com/roster/util/siggen/signature/member=Name@Realm.png

• Avatar:

  http://www.yoursite.com/roster/index.php?p=util-siggen-avatar&member=Name@Realm

  SEO: http://www.yoursite.com/roster/util/siggen/avatar/member=Name@Realm.png

If you host multiple guilds on multiple realms in multiple regions and have characters/guilds/realms that have the same name.
Then you need to specify the region as well:

• Signature:

  http://www.yoursite.com/roster/index.php?p=util-siggen-signature&member=Name@RC-Realm

  SEO: http://www.yoursite.com/roster/util/siggen/signature/member=Name@RC-Realm.png

• Avatar:

  http://www.yoursite.com/roster/index.php?p=util-siggen-avatar&member=Name@RC-Realm

  SEO: http://www.yoursite.com/roster/util/siggen/avatar/member=Name@RC-Realm.png

For example:
To get the graphic for a character named "Bob" on the US realm called "MyRealm", use:

• Signature:

  http://www.yoursite.com/roster/index.php?p=util-siggen-signature&member=Bob@US-MyRealm

  SEO: http://www.yoursite.com/roster/util/siggen/signature/member=Bob@US-MyRealm.png

• Avatar:

  http://www.yoursite.com/roster/index.php?p=util-siggen-avatar&member=Bob@US-MyRealm

  SEO: http://www.yoursite.com/roster/util/siggen/avatar/member=Bob@RCUSMyRealm.png

Alternatively, you can link directly to the generated image if you have chosen to save them on the server. The default file format is .png however this can be changed to .jpg or .gif.

• Signature:

  http://www.yoursite.com/roster/addons/siggen/sig/Bob@US-MyRealm.png

• Avatar:

  http://www.yoursite.com/roster/addons/siggen/ava/Bob@US-MyRealm.png

mod_rewrite

For another method, you can use mod_rewrite to re-write the path to the generator files

Allows you to use

http://www.site.com/roster/MODE/Name@US-Realm.EXT

Replace MODE with the config setting (IE. signature | avatar)
Replace Name@US-Realm with the character's name region and realm
Replace EXT with the extension (IE. png | gif | jpg)

To use the this method, you must have an Apache server with mod_rewrite turned on
Or IIS users need an ISAPI filter

This only allows for the signature and avatar SigGen config designs
If you added other designs, you have to add them in the mod rewrite file

RewriteRule ^/?(signature|avatar|anotherconfig|more|purple)/(.*)

Apache and htaccess

Edit WoWRoster's .htaccess file

After

	# ENABLE ENGINE
	RewriteEngine On

Add

	# SIGEN REWRITE
	RewriteRule ^/?(signature|avatar)/(.*)\.(.*)$ /index.php?p=util-siggen-$1&member=$2&format=$3

So the entire file looks something like this

# WoWRoster .htaccess file
# $Id: .htaccess 1254 2007-08-19 16:41:28Z Zanix $

# ONLY IF MOD_REWRITE IS INSTALLED
<IfModule mod_rewrite.c>
	# ENABLE ENGINE
	RewriteEngine On

	# SIGEN REWRITE
	RewriteRule ^/?(signature|avatar)/(.*)\.(.*)$ /index.php?p=util-siggen-$1&member=$2&format=$3

	# CONIDITIONS
	RewriteCond %{REQUEST_FILENAME} -f [OR]
	RewriteCond %{REQUEST_FILENAME} -d

	# REWRITE RULES
	RewriteRule ^(.+) - [PT,L]
	RewriteRule ^(.*) index.php
</IfModule>

IIS and url-rewrite ISAPI filter

There is a way to mimic mod_rewrite on IIS using an ISAPI filter

One of these may work

• http://www.isapirewrite.com
• http://www.qwerksoft.com/products/iisrewrite
• http://www.opcode.co.uk/components/rewrite.asp

You may need admin access to your IIS installation
I have not tested this, but I hear it does work

The original ISAPI filter I found some time ago has disappeared from the internet, so I have no clue how to configure these products.

Setup

Now that you are sure that GD2 works properly on your server, here is how to get SigGen working

Before you even start trying to access the signatures/avatars, you need to run the configuration page in RosterCP

Log into SigGen Config

First you will need to get to SigGen config

Go to RosterCP, then click SigGen from the Addon Config menu
Or go to /roster/index.php?rostercp-addon-siggen (SEO: roster/rostercp/addon/siggen.html)

Install / Upgrade / Un-Install

Use RosterCP->Addon Management to install, upgrade, or un-install SigGen

SigGen Settings

Note:

A lot of the settings on the SigConfig page have tooltips breifly describing what each function does It is a VERY good idea to click Save Settings after you are done on each page, but it is not required Note: Some settings will automatically "click" the Save Settings button.

Advanced SigGen Options

The fine art of text placement

There are many options for adjusting the placement of the text within the image Here is a guide on how SigGen calculates where to draw the text

• When "Left" alignment is selected, text is drawn from the starting point, going right
• When "Center" alignment is selected, text is drawn equally from that point on both sides
• When "Right" alignemnt is selected, text is drawn from the starting point, going left

Import / Export Settings

You can export and import your SigGen settings for backup or sharing with others

Export

When exporting, SigGen will only export that config mode
So if you are in Signature config mode, hitting Export will save the config settings for Signatures
The file saved will be siggen_signature.txt

Import

When importing, SigGen will only accept text files name like this

siggen_configname.txt

Where configname is the name of the config mode you are currently in

SigGen will also deny importing of newer DB version setting files
So if you saved from SigGen 0.2.5 (which is DB version 1.3) you cannot upload a saved config from this version to 0.2.0, which is DB version 1.2

Starting with SigGen 0.3.0, SigGen will accept a settings file with an older DB version

Image Packs

Image packs have a limited "themeing" ability in that you can specify code to handle how images are selected

Image packs are structured like so

Background image packs do not have a config file, there is no need for one since the Web config is already there

Class and PvP image packs have a file called ext.inc
In this file, you specify the image extension tha will be used, either .png, .gif, or .jpg/.jpeg

Character image packs have a file called char.inc
Now this is where is gets interesting
(Some future version of SigGen will have a web config for this part, but not right now)

The char.inc file allows you to make an if statement to tell siggen.php how to pick a character image

If you do not include this file with a pack, then the default code will pick an image like this if character has race and gender, get race-gender.png

$char_ext = '.png';
if( !empty($sig_race) )
{
	// Set race-gender based image
	if( !empty($sig_gender) )
	{
		// Set race-gender based image
		$im_user_file = $configData['image_dir'].$configData['char_dir'].$sig_race.'-'.$sig_gender.$char_ext;
	}
	// Set race only image
	else
	{
		$im_user_file = $configData['image_dir'].$configData['char_dir'].$sig_race.$char_ext;
	}
 
}	// Set default character image
else
{
	$im_user_file = $configData['image_dir'].$configData['char_dir'].$configData['charlogo_default_image'];
}

Image packs like the teir3 pack pick an image based on race-gender-class.png

<?php
 
if ( !defined('ROSTER_INSTALLED') )
{
    exit('Detected invalid access to this file!');
}
 
$char_ext = '.png';
 
if( !empty($sig_race) )
{
	// Set race-gender based image
	if( !empty($sig_gender) )
	{
		// Set race-gender-class based image
		if( !empty($sig_class) )
		{
			$im_user_file = $configData['image_dir'] . $configData['char_dir'] . $sig_race . '-' . $sig_gender . '-'
					. strtolower(getEnglishValue($sig_class,$sig_char_locale)) . $char_ext;
		}
		else
		{
			$im_user_file = $configData['image_dir'] . $configData['char_dir'] . $sig_race . '-' . $sig_gender . $char_ext;
		}
	}
	// Set race only image
	else
	{
		$im_user_file = $configData['image_dir'].$configData['char_dir'].$sig_race.$char_ext;
	}
 
}	// Set default character image
else
{
	$im_user_file = $configData['image_dir'].$configData['char_dir'].$configData['charlogo_default_image'];
}

siggen.php Direct Access and URL Switches

These are the URL arguments SigGen will accept

• ( member=string ) The name for the script to retrieve and display
• ( mode=string ) What config setting to get from the db ( default options: 'signature' | 'avatar' )
• ( saveonly=[ 1 | 0 ] ) Turns on/off "Save Only Mode"
• ( etag=[ 1 | 0 ] ) Turns on/off "eTag" caching
• ( format=string ) Sets image output format ( current options: 'png' | 'jpg' | 'gif' )

Custom Member Images

Upload

You can set custom images for each character for SigGen, and you can set a custom background as well

Getting images of characters

1. Take a screenshot of your character in WoW

   Or even better, use WoW Model Viewer - http://www.wowmodelviewer.org

2. Open your screenshot in your favorite image editor
3. Edit out the background (make it transparent) and resize to fit inside the signature

   (With SigGen default settings, a good size is h-120px w-120px)

4. Save it as .png, .gif, or .jpg format (24-bit .png with alpha transparency is best and recommended)

• Backgrounds MUST be saved as .png or .jpg, .gif is not allowed

Uploading to SigGen Config

The images you upload can be in .png, .gif, or .jpg format (24-bit .png with alpha transparency is best and recommended)

• Pick the name you want to upload for from the pull down list
• Pick what image type you wish to upload ( Character Image | Background Image )
• Browse to the image you wish to upload
• Hit upload, SigGen Config will tell you if it was successful or not

Delete Member Images

This box will let you delete any currently uploaded images

• Pick the file you want to delete from the pull down list
• Hit delete, SigGen Config will tell you if it was successful or not

Save Image Mode

This is how "Save Image Mode" works

When activated, every visit to SigGen when a name is specified, will generate the image and save it to the server as a static image

This mode is generally used in conjunction with the "Addon Update Trigger"

• Jpeg image quality
  • This controls the level of detail when images are saved in .jpg format
• Gif image dithering
  • This controls the image dithering mode when images are saved in .gif format
• Save images to server
  • This activates/de-activates "Save Image Mode"
• Suppress Image Output
  • Activating this will suppress image output when siggen.php, sig.php, or av.php are accessed directly, but still generate the image and save it to the server's disk
• Convert Accents
  • This will convert accented characters in a player's name to non accented characters when saving images
  • See the next section below for the Accent Mapping SigGen uses
  • WARNING: Any characters with similar looking accents can and will be overwritten
  • See Accent Mapping below for information.
• Saved images directory
  • This is the directory that SigGen will write the generated images to
  • The directory specified here will be a full qualified path on your webserver
    • There is some help with this pathing

      Use %s to specify the SigGen directory (%s may equal /home/webuser/public_html/roster/addons/siggen/)

      Use %r to specify the Roster directory (%r may equal /home/webuser/public_html/roster/)

  • If you change this directory, SigGen Config will try to create the new directory, but it will not move any images that are in the old directory to the new one, nor will it delete them
  • Default Directories
    • Signatures: %ssig/
    • Avatars: %sava/
• Saved images format
  • The format in which SigGen will sve the image to the server
  • Current choices are gif, jpeg, png
• Saved images Prefix/Suffix
  • The text specified here will be added to the filename of the saved image
  • Example
    • The character's name is "Billybobjo"
    • The character's region is "US"
    • The characters realm is "MyRealm"
    • Saved image format is "jpeg"
    • Prefix is set to "prefix-"
    • Suffix is set to "-suffix"
    • The saved image on the server will be "prefix-Billybobjo@US-MyRealm-suffix.jpg"
• UniUploader Fix
  • Enable UniUploader save images workaround
  • Requires "allow_url_fopen" to be enabled on your server!

Accent Mapping

Auto-Save Images

Character Update

Auto-Save images for signatures and avatars

Combining the powers of "Save Image Mode" and "Addon Update Triggers", images can be automaticaly generated and saved on the server everytime update.php is ran

Turning these on will generate and save an image to the server's disk when a player updates their data
Only turn these on after you have configured the signatures

The "Saved Images Directory" has to exist for this to work

To activate, turn on "Auto-save image on character update" on the Main Settings page

Guild Update

This "auto-save mode" can also run during a guild update, which generates an image for every guild memeber

To activate, turn on "Auto-save images on guild update" on the Main Settings page

Note:

You must also enable "Addon Update Triggers" in RosterCP->Configure Main Roster to activate this mode

WARNING:

This can take a very long time. Expect to wait up to 10 minutes, maybe even longer for larger amounts of characters when this is activated

An image is generated and placed on the update page for every member in the guild
Please wait for the page to fully finish downloading all the images to have all of them saved correctly

FAQ/Troubleshooting

Known bugs/weirdness

• Turing off "Display Skill Description" when "Display Riding Skill" is turned on will not remove the Riding Skill Description
  • This is by design
• Save Images box is red and the only option is "Save images to server" and below that is "Save Image Functions Disabled"
  • This is either because "Save images to server" is turned off or the Saved Images Directoy doesn´t exist
• Background Selection Configuration shows as "DISABLED"
  • This is disabled because "Default Background Override" is ON
• Selecting a new background image pack will reset all options for background images
  • You MUST reset all the options when changing the background image pack
• Selecting a new character image pack will reset the default character image option
  • You MUST reset this when changing the character image pack
• Auto-Save Images doesn't work when uploading with UniUploader
  • Enable the "UniUploader Fix" in SigGen Config, "allow_url_fopen" MUST be enabled on your web server!

General FAQ

• Reset to the default settings
  • Check the box and hit Default Settings to reset to defaults