SigGen Documentation

Link to Roster Install Documentation

Table of Contents



Intro

WoWRoster Signature Generator
version: 2.0-Gamma build-50

author: Joshua Clark zanix
e-mail: c.zanix@gmail.com
web: Luminality Guild

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, tradeskill levels, and other such information.
The information in these signature graphics will be as up to date as the roster information.

This is very configurable, everything can be moved fairly easily, text colors can be changed, almost everying can be displayed/hidden
To congifure, open modules.php?name=roster&op=addon&roster_addon_name=siggen in a web-browser

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


Thanks

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

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
rubricsinger For his eXP bar and therefore making want to improve on img.php
zeth_russ Etag cacheing (lovin' the reduced server load!)
RossiRat Ideas on showing debug/error info
Getting the full path for fonts, directories
Shadow fonts
Saving images to a directory on the server
BlackCat83 For the original "avatar.php" using my code from "sig.php"
Jessy For making "av.php" just plug into "sig.php" - Very nice
Matt Miller Code from UniAdmin. Without it I couldn't of made the config page
Ahrtvuailla For help with re-designing the sigconfig page, and a way to delete uploaded images
   
To everyone else that I haven't mentioned
And all those that have tested the previous versions; sig1.5 : sig2.0 : sig2.0-gamma

Requirements

WoWRoster.net Roster v1.6.0-Nuke or higher
PHP 4.3.x or better
GD2 with PNG and Freetype Support
Advanced functions in SigGen Config REQUIRE that safe_mode be turned off in your PHP config file
PHPNuke


SigGen absolutely requires that your PHP installation supports the GD2 library, and that GD2 has PNG Support and FreeType Support turned on

If you have trouble with the signature generator, first check the gd_info.php file in the top-level roster directory for information about how the GD2 library is configured (or not available) on your web server (if you're reading this document off your roster website, try this link).

Then, check the signature troubleshooting thread at WoWRoster.net

gd_info.php MUST SAY FreeType Support: yes for you to use SigGen
FreeType Linkage: with freetype is best although with TTF works ok

If you DO NOT want SigGen, or if you cannot get GD2 to work on your server, you can just delete the folder from the addons directory /addons/siggen/ and that will remove all traces of SigGen


File Structure

The addon "SigGen Gamma" for signature and avatar graphics is included in the default roster package

Here are the files and where they should be located

SigGen File Structure
SigGen File Structure

Usage

The PHP file that generates the signatures is sig.php, for avatars it is av.php
They are located in /addons/siggen/

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

The generators are at:
Signature: http://www.yourguildname.com/modules/roster/addons/siggen/sig.php
Avatar: http://www.yourguildname.com/modules/roster/addons/siggen/av.php

To get the graphic for a character named "Bob", use:
Signature: http://www.yourguildname.com/modules/roster/addons/siggen/sig.php?name=Bob
Avatar: http://www.yourguildname.com/modules/roster/addons/siggen/av.php?name=Bob

Alternatively, you can try to use these:
Signature: http://www.yourguildname.com/modules/roster/addons/siggen/sig.php/Bob.png
Avatar: http://www.yourguildname.com/modules/roster/addons/siggen/av.php/Bob.png
NOTE: This method for accessing these does not work on all servers

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

To use the this method, you must have an Apache server with mod_rewrite turned on

.htaccess file (for Apache)

RewriteEngine on
RewriteRule ^(sig|av)/(.*).png$ ./addons/siggen/$1.php?name=$2

There is a way to mimic mod_rewrite on IIS using an ISAPI filter
http://www.iismods.com/url-rewrite/index.htm
You need admin access to your IIS installation
This is untested and may not work

mod_rewrite.ini file (for IIS with URL Rewrite Filter for IIS)

Debug 0
Reload 1000
RewriteRule ^(sig|av)/(.*).png$ ./addons/siggen/$1.php?name=$2

With the power of mod_rewrite you can access your images at:
Signature: http://www.yourguildname.com/modules/roster/sig/Charactername.png
Avatar: http://www.yourguildname.com/modules/roster/av/Charactername.png

SigGen signature/avatar Example
SigGen Example


Setup

(Back to ToC)


Install

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 at
http://www.yourguildname.com/modules.php?name=roster&op=addon&roster_addon_name=siggen
(if you're reading this document off your roster website, try this link)

This will set up the database tables and will give you great control over the look and feel of your signatures

Choose your version of MySQL your server is running
( If you are unsure, try MySQL 4 or less )

SigGen DB Install
SigGen DB Install

The next screen should show the following
Follow the directions (There is only one)

SigGen DB Install Successfull
SigGen DB Install Successfull

Upgrade

This mode appears when you already have the `sig_config` table in the database

You have three options

SigGen DB Upgrade
SigGen DB Upgrade

Editing the conf.php file

SigConfig password $sc_pass

By default, this is set to $roster_upd_pw which is set in roster's conf.php file
You can change this if you want to use a different password

Show the SQL Debug Window $sc_show_sql_win

This toggles the display of the SQL Debug window in SigGen Config
Set to 0 to turn off the window



Log-in to SigGen Config

(Back to ToC)

Fill in the password box from what you set $roster_upd_pw in conf.php
This config page uses cookies so you don't have to log-in everytime you re-visit this page

SigGen Password
SigGen Password


SigGen Settings

(Back to ToC)

Alot of the settings on the SigConfig page have tooltips breifly describing what each function does
It's a VERY good idea to click Update Settings after you are done on each page, but it is not required

Config Select

Select which mode to edit. Either signature or avatar
Hit Go to select that mode

SigGen Config Select
SigGen Config Select

The Menu

Select which part of SigGen to configure

SigGen Menu
SigGen Menu

Signature/Avatar Preview (Test SigGen)

Use this to test your changes to SigGen
The drop down list is populated with the members in your guild
Select a name then hit Go to view that character's image

SigGen Image Preview
SigGen Image Preview

Main Settings

This is where you set the main settings for SigGen

SigGen Main Settings
SigGen Main Settings

Backgrounds

Control the display of the background in SigGen

All image selection pull down boxes are automatically filled from the /img/ directory

Display options for the colored frames and the outside border are here as well
You can set each of these to "--None--" to disable their display

The options for the backgrounds are very customizable
The default set-up for SigGen is to check for the character's race, and match to that race's home city

For example, the "Search Config" is set to read from "Players Table", "race" field by default
When the character's race matches one of the search's below, their background is set to that background filename
(when char.race = "Night Elf", set backg = darnassus)

NOTE: When you change the "Table:" option, you need to hit Update Settings to get the new list of fields

You can set this up to search for the character's guild title, and match that to a specific image

So for every character that has a guild title of "Member", "member_image" is set as their background image

SigGen Background Settings
SigGen Background Settings

Fonts and Colors

Here you can select what fonts and colors are available to the other areas of SigConfig
If you change anything here and want it available to the other sections, you need to click Update Settings first

For the color selection, you can click on [color swatch] to open a "color picker" window to help you choose a color

SigGen Fonts and Colors
SigGen Fonts and Colors

The eXp Bar

This is where you can adjust the display of the eXp bar on the generated image

SigGen eXp Bar
SigGen eXp Bar

The Level Bubble

Control the display of the level bubble

You can set "Level Bubble Image Name" to "--None--" to turn off the image and keep the text

SigGen Level Bubble
SigGen Level Bubble

The Skills Block

Control the display of the character's skills, trades, and mount info

The order of the skills will always display in this order, whether or not each part is turned off

SigGen Skills Block
SigGen Skills Block

Character/Class/PvP Logos

Control the placement of the Character Portrait, PvP Rank Logo, and the class logo

SigGen Logos
SigGen Logos

Text Configuration

Control the placement and display attributes of each piece of text on the generated image

SigGen Text Configuration
SigGen Text Configuration


Advanced SigGen Options

(Back to ToC)


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

Hover-over [example] for an example

Alignment Horiz point Width of text Starts drawing Ends drawing
Left
[example]
200 50 200 250
0 30 0 30
395 10 395 405
Center
[example]
200 50 175 225
0 30 -15 15
350 10 345 355
Right
[example]
200 50 150 200
0 30 -30 0
350 10 340 350

siggen.php Direct Access

These are the arguments siggen.php will accept (applicable to sig.php, and av.php as well)


Upload Custom Member Images

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

SigGen Upload Images
SigGen Upload Images

The images you upload must be in .png format (24-bit color is best) with a transparent background


Delete Member Images

This box will let you delete any currently uploaded images

SigGen Delete Images
SigGen Delete Images

Save Image Mode

This is how "Save Image Mode" works

When activated, every visit to siggen.php, sig.php, or av.php, 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 "Update Trigger"

SigGen Save Image Mode
SigGen Save Image Mode

Auto-Save Images

Auto-Save images for signatures and avatars
Turning these on will generate and save a signature and/or avatar image to the server's disk when a player updates their data
Only turn these on after you have configured the signatures

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

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

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

SigGen Auto-Save on Character Update
SigGen Auto-Save

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

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

You must also check the "Run Update Triggers" on update.php to activate this mode

WARNING: This can take a very long time. Expect to wait 10 minutes or longer when this is activated
This can, and probably will, use 100% of the server's processor time
If your site is hosted, they will most likely smack you for this action

You also may get time-out errors, there is protection against this but it wont work on some servers
If you do get time-out errors, then you should disable this
SigGen Auto-Save on Guild Update
SigGen Auto-Save

FAQ/Troubleshooting

Known bugs/weirdness

General FAQ

SigGen Reset to Defaults
SigGen Reset to Defaults