The most basic graphic can be obtained by setting the "Region/Game" and "Server Pattern". All other fields are optional.
These are some general formatting controls.
Some sensible defaults are shown which suit the default image for Display Set setting "0 - horizontal".
If you wish to use this feature simply select "Enable" from the "Enable Player List".
Player Pattern
The pattern is a regular expression that players must match to be included in the list. The pattern is case insensitive. For simple searches enter part of the player name(s) you wish to match. For example, if your clan always has ABC in their name then enter ABC as the pattern. Use a . to match any character, so A.C would match ABC, ADC, AEC etc. A plaer pattern simply of . will match every player. If the player pattern is not set we assume you want to show all players. More advanced searches can be performed and are sometimes desirable. For example, if your clan name was ABC and it was always at the start of the player name, the simple search for ABC would show your clan members as well and any one else you just happened to have ABC anywhere in their name. To resolve this problem we could specify that the ABC must only match if it is at the start of the player name. This is achieved by using the pattern ^ABC. Take a look at the following examples: Matching multiple players in one search: eg AW|IWI Match players starting with some text: eg ^AW Match Players ending with some text: eg FMS$ Combinations: eg ^AW|FMS$ That should cover most uses. Experts can read up on Regular Expressions!
Number Per Line
The number of players to show per line. If not specified, defaults to 1. Line Height
The number of pixels high each line is. If not specified, defaults to 10. This will control how close together the players are shown. Max Number of Players
The maximum number of players to show. If not specified, defaults to all and is limited to the maximum number of players the server can accomodate. If you do leave this blank and you are also using the "Show Players From All Servers" mode then this could be a large list and hence a large image. We might be able to handle or perhaps we'll just give up ....
Growth Pixels
This is the number of pixels that we will increase the height of the image by for each line of players shown. If not specified, defaults to 0. You may like to make this the same value as LineHeight to make the image grow in direct proportion to the number of lines of players shown. If you have specified a background image using the style parameter then you will not be able to "grow" the image. Growing the image starts at the specied image size. If you wanted a fixed image size you would not set this parameter and you would make sure the image size you specify is capable of showing the number of players you want to show - test this using the "Num Dummy Players" option. Num Dummy Players
The number of dummy players to add to the player list. The default is 0. Use this when testing how your image will look with certain numbers of players. For example, you might like to set it to 32 if your server can support 32 players to see how the image will look. Dummy player names are shown as 16 characters long, which is the maximum you should ever see. We never show more than the number of players that the server can accomodate. Delimiter
The character to show between players. The default is to show nothing. Use the word "comma" to use a comma between players, leave it blank to show nothing. Fixed Width
The number of characters to fix the length of the player name at. The default is not to fix width the player name. If you are trying to display the player names in columns then you'll probably want to set the value of this to the maximum size of the player name eg 16. By default, the names are right-aligned. You can make them left aligned by prefixing this value with a minus sign eg -16. Player List Sort Options
Descending, Case Insensitive Descending, Case Sensitive Ascending, Case Insensitive Ascending, Case Sensitive Specify sort paramters for the player list. The default is to use the order returned to us by our data source - who knows how they do that ...
Showing Players From All Servers Normally the generated image is all about showing information about a single server. This is mode designed to list players across any number of servers. There are some special considerations in using this mode of operation. When this mode is enabled, the following occurs: The serverpattern is removed, The field group is set to "none", The player list is enabled (if not already), The player pattern is set to "." to match all players. The most number of players we will show is defined by the "Max Number of Players" setting. You must always specify a "Player Pattern", leaving it blank will show no players. You will probably need to adjust the size of the image (most likely the width). You will probably want to change the Horizontal and Vertical Location of the list. Enable
Tick this check box to enable this mode of operation. Player Name Formatting
If you want to show the server that the player is on you can also do this. In order to do this you need to specify a formatting parameter which allows you to control whether the server name comes first or goes last, the spacing parameters and any other characters eg put the server name in brackets. This can get a little tricky and the best way to do this is to use one of the samples from the drop down box below. Read more detail on this if required in the How-to guide (See the "Options Tab")
Player Name Formatting Samples
Formatting the player list can be quite complex, use these options as some quick settings. These we probably cover most uses. The last one is special and is probably the one you will want for 2 main reasons - we have designed it for showing players and the servers that they are on and it sets more than jsut the player list formatting. It also: Positions the player list, Resizes the image, Puts titles on the columns (see the "Text Fields" tab), Sets the other player list options to reasonable values, Sets the maximum number of displayed players to 200. Server Player (Fixed, Left Justify) Server Player (Fixed, Right Justify) Player Server (Fixed, Left Justify) Player (Server) (Variable) Player SERVER:(Server) (Variable) Player SERVER:(Server) (Fixed, Left Justify) Server Player (Multiple Options Set)
These settings provide control over which fields are shown where. If you have selected a "Field Display Group" then some of the required fields will already be displayed on the image. This allows you to override the "Field Display Groups" or add additional fields. For a field to be displayed on the image just must specify at least a "Horizontal Location", a "Vertical Location" and a "Field Name".
These settings provide control over which icons are shown where. If you have selected a "Field Display Group" then some of the icons will already be displayed on the image. This allows you to override the "Field Display Groups" or add additional icons. For an icon to be displayed on the image just must specify at least a "Horizontal Location", a "Vertical Location" and an "Icon Name".
These settings allow you to show arbitray text on the image.
For the text to be displayed on the image just must specify at least a "Horizontal Location", a "Vertical Location" and some "Text".