Signature Generator help file

About
License
Instruction

Main window
Settings
Scripts
Supported games

About

Signature Generator (GS) is an application dedicated to players who want to have a unique signature, along with statistics from their favorite game (or several).
I would like to point out that this is a test version with a specially made certain limitations, namely:
- max image size of 350x100,
- export to jpg files only,
- limiting the stats download - no more frequently than every 4 hours,
- a signature can be only uploaded on your hosting account via ftp protocol -> file is uploading to the root directory, file name "sygnatest.jpg"

A general description of the program:
The generator performs a specified script, creates the image based on it, and send it to the ftp server.
Name of the generated file: "sygnatest.jpg"
address of the image: http://your_site.domain/sygnatest.jpg
forum code: [IMG] http://your_site.domain/sygnatest.jpg [/ IMG]

Note:
Currently, the program can upload the signatures via ftp, hosting must allow Hotlinking (to images can be loaded from another domain).
There is many small hosting servers that meet these requirements.

Currently the program is only available for Windows, but versions for Linux and Mac OS will be developed in the future.

License

Signature Generator is available as a free program on the principles of freeware, the precise content of the license is provided with the program.
This means that there are no royalties for using the application. It can be placed in any website / journal, preserving the information that it's a free product, information about the author and the project site.

However, as with other free projects, providing bug fixes, updates and new functionality is depends on free time, where you can focus on the program. Sometimes you also need to test the program in another system, to check why a feature does not work, not having the opportunity to test the program under a new / different system.
Therefore, you are asked if you want to help in developing this program, you think it is worth it, Support it, leaving a any amount to its development. All necessary information can be found at my site . Thank you in advance for your interest in the subject.
Or maybe you're interested in placing a dedicated version of app on your www / CD added to the magazine in exchange for a little financial support for the project. This version will not have new features, the only change would be such a different layout, banner redirecting to your site, the information that it was you / Your newspaper supports the development of this program.

Instruction

Application is quite intuitive and simple to use.

Main window

"Script" -> your script, that generator will do
"Background image" -> image that will be used as bacground for your signature
"Create signature" -> create signature - following the script
"Upload file" -> upload file to server

Settings

"File upload method" -> file upload method - cyrrently only through ftp server
"Server", "User", "Password" -> your account data
"Check connection" -> check connection
"Save as .. filetype" -> signature file format - now only jpg
"Image quality" -> compression
"Colors" -> more compression option

Scripts

Each instruction has same structure:
[instruction_name-parameter1-parameter2] -> each parameter proceded by dash

Instruction list


[getstatus-game-server-id_gracza-nick] -> get stats for selected player

->>Currently stats can be recieved from StarCraft 2, BloodWars - polish servers.

[nick] -> player nick

[points] -> player points

[race] -> race (most/last played)br />
[ranking] -> place in rank

[clan] -> actual clan

[id] -> 

[fights-x] -> fights/battles

Graphic commands:


[fcolor-$BBGGRR] -> foreground-drawing color -> Blue|Green|Red, coded in Hex

[bcolor-$BBGGRR] -> background color, transparent color -> [bcolor-$FF00FF]

[posx-value] -> move drawing cursor to x position

[posy-value] -> move drawing cursor to y position

[font-font_name] -> change current font to selected -> finish with [/font]

[size-font_size] -> change font size -> finish with [/size]

[b] -> bold -> need to be finished with [/b]

[i] -> italic -> need to be finished with [/i]

Sample script - without getting player stats:


[size-13][b][font-Comic Sans MS][posx-15][posy-5][fcolor-$FFFFFF]Test [bcolor-$0000bb][/b]gener[b]atora[bcolor-$ff00ff] [fcolor-$007799]sy[fcolor-$0099BB]gn[fcolor-$00BBDD]at[fcolor-$00DDFF]ur[/size]

[fcolor-$33CC33][i]TY te możesz mie tak sygnę![/i]

[bcolor-$bb0000][fcolor-$00FFFF]Test[bcolor-$000000][fcolor-$0000FF][size-11] Dla dowolnej gry

Supported games

Actuall list of supported games is available on project site.

BloodWars


		[arena-number] -> statistics from the arena: a number from 0 to 7 

		0,1,2,3 -> beasts - wins, losses, ties, experience 

		4,5,6,7 -> players - wins, losses, ties, balance rep 

		eg. [arena-4] -> give the number of wins against players on arena

Example script for BW:


[posx-65][posy-35]

[fcolor-$bb5555][b]][getstat-bw-r3-29480]R3 [nick] - Rank [ranking] - Points [points][/b]

[font-Courier]My id: [id]

[b][posx-170][posy-83][fcolor-$1111ff][bcolor-$000000] www.bloodwars.pl [/b][/font]

Basic stats for player with id 29480 from 'r3' server.

Starcraft 2
link to player profile look like this http://server.battle.net/sc2/en/profile/your_id/1/your_nick/
underlined parameters need to be placed in getstat command
>>[getstat-sc2-server-id-nick] => server can be eu, us, sea etc

[race] -> most played race
[fights-x] -> number of fights

0 -> League Wins
1 -> League Games
2 -> Custom Game
3 -> Co-Op vs AI
4 -> FFA
5 -> 1v1 - total games
6 -> 1v1 - wins
7 -> 2v2 - total games
8 -> 2v2 - wins
9 -> 3v3 - total games
10 -> 3v3 - wins
11 -> 4v4 - total games
12 -> 4v4 - wins

Sample script:


[getstat-sc2-serwer-id-nick]

[size-13][b][font-Comic Sans MS][posx-125][posy-5][fcolor-$FFFFFF][nick] -> [punkty] Points[/font][/b][/size]

[fcolor-$33CC33]Favorite race: [b][rasa][/b][fcolor-$FFFFFF]

[b]1v1: [fights-5] Games, [fights-6] Wins

League: [fights-1] Games, [fights-0] Wins [/b]

[b][posx-170][posy-80][fcolor-$1111ff][bcolor-$000000]   StarCraft 2   [/b]

Technical problems.

Q: My antivirus program warns that the Signature Generator is a virus!
Re: Check if the executable (for Win - exe) is the appropriate size -> go to the download section on my website.
If the size is correct it may be caused by your anti-virus system Heuristics - as the GS is low size, he might be considered for the virus, download a special version of the exe file.

Q: How do I set up automatic updating of signatures?
Re: Create a shortcut to the program, add the parameter -auto, running with this setting works in invisible mode and automatically execute the script and upload the file on the ftp. You can also add a shortcut to the startup, it will start at every system startup.

Q: Will I be able to have bigger signatures?
Re: Yes, current limitation (350x100) is made because this is test version.

Q: Will I be able to save the signature as a PNG, GIF ..
Re: In Future you will be able to choose the format in which to save the file, PNG is certain, the GIF it's hard to say for now.

Q: The program does not want me to start, what should I do?
Re: There could be many, the most common is the antivirus / firewall programs, which will not alert to block the application.
GS should run on any edition of Windows from 95 onwards, the default installation - not SP required, or additional libraries.

Q: If you have any problems, questions can contact me.
Re: Please write to: dreamerman@wp.pl
Note that the write-down time is dependent on free time and opportunities.