ServerLogoTV 1.1
=============
by Byte (byte@tsncentral.com)
Homepage: http://byte.zenegg.com
note: ServerLogoTVa.u will automatically download to servers on connection, if not manually installed.
Changes in 1.1
-----------
Changing filename to keep any clientside mismatches to a minimum.
Revised Positioning Code for Logo to allow finer control (see Config Values)
Added a message for each client - that your server is running ServerLogoTV
Note: With filename change, you will need to change the Header name in your Ini to reflect
the new Filename - [ServerLogoTV.mutLogoserver] = [ServerLogoTVa.mutLogoServer]
Description
-----------
ServerLogoTV displays a logo when a player connects.
Installation
------------
Extract ServerLogoTVa.u to your Program\Bin folder
(eg. C:\Program Files\VUGames\Tribes Vengeance\Program\Bin)
//-------------------------------
You will need to add the following lines to the [Engine.GameEngine] section of your Server ini:
After the last ServerActors reference add:
ServerActors=ServerLogoTVa.mutLogoServer
At the bottom of the ServerPackages references, add:
ServerPackages=ServerLogoTVa
You need to add the packages containing the logo texture to the ServerPackages (under the above line):
example - ServerPackages=YourLogoPackage
Your Texture package should be something uniquely named which might not always be possible,
but at worst, at a number or so, to basically "seperate" it from any potential conflicts.
The Config Values
-----------------
In the [ServerLogoTVa.mutLogoServer] section of your server's INI file you can find
the following configurable variables - after initial run...
Logo
The logo texture. Make sure that the package this texture is in is in the
ServerPackages.
LogoColor
The color used for drawing the logo texture. The alpha component of this color
can fade in and out with the FadeInAlphaTransition and FadeOutAlphaTransition
variables described further down in this section.
LogoX
The relative location on the screen where the logo will display
(1.0 = Bottom Right of Screen)
LogoY
The relative location on the screen where the logo will display
(1.0 = Bottom of Screen)
// NEW!
LogoOffsetX
A relative(to LogoX) location on the screen where logo will display
LogoOffsetY
A relative(to LogoY) location on the screen where logo will display
Example:
Your logo is 256x128 and you would like it fullsize in the middle of the screen.
LogoX and LogoY would be 0.5
LogoOffsetX would be -128
LogoOffsetY would be -64
LogoScale would be 1
If you scaled it by Half, then you would drop those numbers by that much as well.
//
LogoScale
This is a relative value for Scaling to be applied to the Logo Material.
(1.0 = Full Size)
FadeInDuration
How long it takes to fade in the logo.
DisplayDuration
How long the logo will be displayed after fading in.
FadeOutDuration
How long it takes to fade out the logo.
InitialDelay
How long to wait before starting to fade in the logo.
FadeInAlphaTransition
FadeOutAlphaTransition
How the logo's transparency changes when fading in/out.
FT_None means always full opacity.
//---------------------------------------------------------
Example Ini entry - Default:
[ServerLogoTVa.mutLogoServer]
Logo=GUITribes.PoweredByGamespy
LogoColor=(B=255,G=255,R=255,A=255)
LogoX=0.500000
LogoY=0.500000
LogoOffsetX=-256
LogoOffsetY=256
LogoScale=0.500000
FadeInDuration=3.000000
DisplayDuration=5.000000
FadeOutDuration=1.500000
InitialDelay=8.000000
FadeInAlphaTransition=FT_ReverseSquareSmooth
FadeOutAlphaTransition=FT_SquareSmooth
This is the default - If you place this at bottom of your Server's ini and make
changes - it will pull those changes in.
What are the available transitions?
-----------------------------------
All transition settings take the values FT_None, FT_Linear, FT_Square, FT_Sqrt,
FT_ReverseSquare, FT_ReverseSqrt, FT_Sin, FT_Smooth, FT_SquareSmooth,
FT_SqrtSmooth, FT_ReverseSquareSmooth, FT_ReverseSqrtSmooth and FT_SinSmooth.
How to create custom server logos
---------------------------------
First of all, create your logo image. You can either use 8 bit (256 colors)
with BMP or PCX or 32 or 24 bit (truecolor with or without alpha channel) with
TGA or DDS as the file format. Please make sure no MipMaps are saved with your
texture - In TVEd, if it says more than 1 mips, then you need to resave the DDS
without MipMaps or uncheck the Generate MipMaps option in TVEd
The image size must be powers of 2, i.e. 2, 4, 16, 32, 64, 128, 256, 512 or
1024. The image doesn't have to be quadratic, so sizes like 128x512 are allowed
as well. When saving your logo image, make sure neither its file name nor the path
you save it in contains any space chars, otherwise you won't be able to import it
from that location. Now import the logo image as a texture in TVEd and make
sure you specify a new package name.
You should save your Package into Content\Art...
(eg. C:\Program Files\VUGames\Tribes Vengeance\Content\Art)
DO NOT MODIFY ANY EXISTING PACKAGES!
Especially since you don't have to worry about the ServerLogoTV code, that's what
the configuration options are there for. The new logo's name for the ServerLogoTV
configuration is in the form PackageName.GroupName.TextureName, where PackageName,
GroupName and TextureName are the names you specified in the import dialog box.
note: PackageName will be the Filename in the end...
You can test this Clientside by having the .u file in Program\Bin, and setting up
your ini, etc.. and going in game (w/ console) and typing "open MP-Cavern" (without quotes)
and then "Summon ServerLogoTVa.mutLogoServer"... which will spawn the code and should show
your logo.
Known Bugs
----------
None.
Feel free to mail me if if found a bug or incompatibility. Please tell me which
mods and/or mutators you used and please try to describe how the bug can be
reproduced.
Contained files: example.jpg, Readme.txt, ServerLogoTVa.u
No comments added