SmartCTF 4.0 - {DnF2}SiNiSTeR Edition 1.0

This page contains documentation about the tweaking I did to the SmartCTF mod.

This mod was originally made by {PiN}Kev on January 2004, and linked to http://pin.progameplayer.com/SmartCTF but that site doesn't seem to work anymore.

Tweaked by {DnF2}SiNiSTeR on November 2004. Besides listing my changes, on this site you can also find an user / admin manual.

Site: http://www.dnfclan.com/~sin/SmartCTF


Contents

  • Changelog / Features

  • Installing

  • Options in the .INI File

  • Pointsystem and Rules

  • Commands and Keybinds

  • Contact

  • Original Readme


  • Changelog

    SmartCTF V4.0 - {DnF2}SiNiSTeR Edition 1.0

    1. Fixes the "flagbug" where the flag is sent home when the FC disconnects. Now it is dropped there.
    2. Lots of booleans you can set in the .ini file to hide certain SmartCTF messages on your server.
    3. Same goes for setting SmartCTF bonuses and almost every other SmartCTF feature.
    4. Can be setup as Server Actor so you don't have to select the mutator each time. Doesn't load for non-CTF gametypes.
    5. Optional 'Assist' sound at assist, 'Capture' sound at capture and 'Nice Catch' sound at save.
    6. SmartCTF messages have their own spot and don't interfere with other messages, this also fixes the Saved message bug.
    7. Works with bots (thus offline) now as if they were players also.
    8. Enhanced MultiKill Messages (Triple Kill & MegaKill + Announcer).
    9. Code reformatting, various small code tweaks and optimalizations.
    10. Rules for Cover Kills altered a bit (more flexable).
    11. Missing Announcer sound on '30 second remaining' included.
    12. Other small sounds added for some SmartCTF messages.
    13. Long Range Kill detection and message at headshot location (headshot has preference).
    14. Powered by SmartCTF message/logo.
    15. Small Statboard enhancements.
    16. Shows "Deaths" instead of "Seals" if no Seals.

    SmartCTF V4.0

    1. Option to turn off all smartCTF messages for those who fear distraction in matches.
      -mutate SmartCTF messages off/on
    2. Displays FC location right bottom side when your team has flag. No more need to F1.
    3. Added flag return points as follows: Flag returns in own base = 0.5 pts. Flag returns in mid = 2pts. Flag returns in enemy base = 4 pts. Flag returns very close to capping = 8 pts with a big message.
    4. Auto screenshot option for tourney mode maps. D/L the ini from main page and put in system dir.
    5. Fixed assist bug where some times it didn't reward as it should.
    6. Fixed accessed nones. No more scriptwarning: SmartCTF.broadcastlocalizedMessage stuff in the logs.
    7. Fixed current time error for month.
    8. Auto brings up stats at end of game.
    9. No longer made stats override F1, so people who dont have the stats binded can turn it off easier with F1.

    SmartCTF V3.0

    1. Team scores on top
    2. Added ping , pl, and time for each player
    3. Shows server name at bottom
    4. Shows game ended message at top
      So now with those you can take SS of SmartCTF stats instead of F1 after each map in matches/tourneys.
    5. Now logs covers and seals into ngLogs (Prompted by dio\Apollo's ngLog parser: http://www.clan-dioscuri.com/serverstats.php) very nice stuff.
    6. Added current time for those who lose track of time playing. The time is YOUR time, whatever your computer is set to.
    7. Fixed some point system errors.

    SmartCTF V2.0

    1. Fixed bug where not all players are drawn sometimes.
    2. Sorted names by score
    3. Changed color scheme for easier reading. The ammount of green in bar reflects the raw number of the stat.
    4. Added flag icon next to FC
    5. A cover kill is now either if the victim can see FC, ** OR ** if he's within 800 unreal units of FC (Approx 50 ft).
    6. Auto turns off F1 when viewing stats
    7. Made the number of pulse kills it takes to get pulse whore message configurable via ini. Just put the ini in the system folder.
    8. Fixed some bugs like suicides not resetting the 30-kill spree, not resetting list of ppl who assisted or covered/sealed after flag return.
    9. Fixed some accessed nones, which have no impact on server performance.
    10. Please remove all earlier versions of SmartCTF. I forgot to label the 1st one SmartCTFV1 in the mutator list, but this one is labeled SmartCTFV2.

    Installing

    SmartCTF is a serverside mod. This means it has to be installed on the server. It should also be added to the ServerPackages so clients will download it automatically to be able to see stats and the likes.

    The manual steps are as follows:


    Options in the .ini file

    Just open up the SmartCTFV4_SiN.ini in the UT\System folder. If you can't find it, run SmartCTF one time to generate it with the default options.

    Explanation

    NameDefault ValueDescription
    CapBonus
    AssistBonus
    CoverBonus
    SealBonus
    FlagKillBonus
    8
    7
    2
    2
    0
    Here you can enter the SmartCTF bonuses. Remember this gets added to default UT scorings. You can only enter integer numbers, and can use something like -1 to decrease in score, for example setting FlagKillBonus to -1 will give 4 points instead of standard 5 on a flagkill.
    BaseReturnBonus
    MidReturnBonus
    EnemyBaseReturnBonus
    CloseSaveReturnBonus
    0.500000
    2.000000
    4.000000
    8.000000
    If you return the flag in a specific playerzone or really close to the flag. These can be decimal numbers hence the 0.5 pts for base returns. You don't see decimals on the scoreboard.
    bEnabledTrue You can totally disable the loading of SmartCTF by setting this to False.
    bFixFlagBugTrue If True, the flag will be dropped if the FC disconnects or lags out, instead of being send home which is the default UT functionality. Hopefully this will prevent some 'lagoutcaps' in clanwars.
    bShowFCLocationTrue Clients will see the location (playerzone) of their own Flagcarrier in the bottom right corner of the screen.
    StartupLogoSize3 0..3, on joining a server a player will see a logo. If you think this is too big, you can fill in 2 for 3/4 size or 1 for 1/2 size here. Doesn't look as nice though. If you enter 0, no logo will be displayed but instead a 2 line console message.
    bShowXXXXXMsgTrue You can hide certain SmartCTF messages by setting this to False.
    bShowCoverMsg: ... covered the flagcarrier!
    bShowCoverSpreesMsg: ... is on a multi cover / cover spree !
    bShowSealMsg: ... is sealing off the base!
    bShowSavedMsg: Saved By ...!
    bShowLongRangeMsg: Über / Long Range Kill! (Non-sniper/insta/trans/deemer kills over huge distances)
    bShowXXXXXConsoleOnlyFalse Gets ignored if bShowXXXXXMsg is False. If this property is True then the message will be displayed in the console only, and not on the HUD in green letters.
    bShowSealRewardConsoleMsg
    bShowCoverRewardConsoleMsg
    bShowAssistConsoleMsg
    True These are the 'reward on cap' and 'assist' messages displayed in the console, you can disable them also.
    bPlaySavedSound
    bPlayCaptureSound
    bPlayAssistSound
    bPlay30SecSound
    True Additional Announcer sounds, "Capture" at a flagcap, "Assist" when you get an assist bonus and "Nice Catch!" if you do a Flagsave. And the missing "30 seconds remaining..." sound (sounds a bit odd tho :s)
    bAfterGodLikeMsgTrue Enable the additional killingspree message after Godlike, "Too Easy For.."
    bEnhancedMultiKillTrue Enable enhanced multikills. Inserts 2 extra phases, in color changing messages and unlimited MonsterKills.

    Public servers / default

    Now, understandably we want different settings for a public funserver and a clanserver. I can imagine the default settings will do fine on a public server, these are basically the full settings. Here they are again:

    [SmartCTFV4_SiN.SmartCTF]
    bEnabled=True
    CapBonus=8
    AssistBonus=7
    FlagKillBonus=0
    CoverBonus=2
    SealBonus=2
    BaseReturnBonus=0.500000
    MidReturnBonus=2.000000
    EnemyBaseReturnBonus=4.000000
    CloseSaveReturnBonus=8.000000
    bFixFlagBug=True
    bEnhancedMultiKill=True
    bShowFCLocation=True
    bAfterGodLikeMsg=True
    bPlay30SecSound=True
    StartupLogoSize=3
    bShowCoverMsg=True
    bShowCoverConsoleOnly=False
    bShowCoverSpreesMsg=True
    bShowCoverSpreesConsoleOnly=False
    bShowSealMsg=True
    bShowSealConsoleOnly=False
    bShowSavedMsg=True
    bShowSavedConsoleOnly=False
    bShowLongRangeMsg=True
    bShowLongRangeConsoleOnly=False
    bShowAssistConsoleMsg=True
    bShowSealRewardConsoleMsg=True
    bShowCoverRewardConsoleMsg=True
    bPlayCaptureSound=True
    bPlayAssistSound=True
    bPlaySavedSound=True
    

    Clanservers

    This gets rid of CTF big screen messages like "X covered the flagcarrier" and "X is sealing off the base", and the FC location in the bottomright of the screen. Furthermore 'funstuff' like Enhanced Multikill is disabled. Some console messages remain, but you can tune this down even further if you want.

    [SmartCTFV4_SiN.SmartCTF]
    bEnabled=True
    CapBonus=8
    AssistBonus=7
    FlagKillBonus=0
    CoverBonus=2
    SealBonus=2
    BaseReturnBonus=0.500000
    MidReturnBonus=2.000000
    EnemyBaseReturnBonus=4.000000
    CloseSaveReturnBonus=8.000000
    bFixFlagBug=True
    bEnhancedMultiKill=False
    bShowFCLocation=False
    bAfterGodLikeMsg=False
    bPlay30SecSound=True
    StartupLogoSize=1
    bShowCoverMsg=False
    bShowCoverConsoleOnly=False
    bShowCoverSpreesMsg=False
    bShowCoverSpreesConsoleOnly=False
    bShowSealMsg=False
    bShowSealConsoleOnly=False
    bShowSavedMsg=True
    bShowSavedConsoleOnly=False
    bShowLongRangeMsg=False
    bShowLongRangeConsoleOnly=False
    bShowAssistConsoleMsg=True
    bShowSealRewardConsoleMsg=True
    bShowCoverRewardConsoleMsg=True
    bPlayCaptureSound=True
    bPlayAssistSound=True
    bPlaySavedSound=True
    

    Default UT scoring

    If you want the default UT scoring, and not the SmartCTF enhanced point system, just set all bonuses to 0.

    CapBonus=0
    AssistBonus=0
    FlagKillBonus=0
    CoverBonus=0
    SealBonus=0
    BaseReturnBonus=0.000000
    MidReturnBonus=0.000000
    EnemyBaseReturnBonus=0.000000
    CloseSaveReturnBonus=0.000000
    

    Changing settings as admin

    Any client logged in as admin can easily change these settings by typing commands like this in the console:
    admin set SmartCTF CapBonus 5
    admin set SmartCTF bShowFCLocation False

    Use a command like admin get SmartCTF bFixFlagBug to request the current value.

    Note that some properties might require a restart of the game to take effect!



    Pointsystem and rules

    Default points

    SmartCTF changes the points you receive. They can now be changed by the server admin, if you want to check a certain server's settings just type 'mutate smartctf rules' in the console. Here is the default setting.

    ActionUT ScoreSmartCTF BonusTotal
    Capture7815
    Assist-77
    Flagkills505
    Covers1*23
    Seals1*23
    Flagreturns in own base-0.50.5
    Flagreturns in mid-22
    Flagreturns in enemy base-44
    Flagreturns really close-88

    * The 1 score you get from UT is because of the normal kill you did.

    Rules


    Commands and Keybind

    The following commands can be typed by clients in the console:

    mutate smartctf
    General info.

    mutate smartctf rules
    Shows all bonuses settings for the server.

    mutate smartctf stats
    Display the stats over the HUD, type again to hide them.

    A good tip is to bind the statboard to F3. This only gets used for Assault so during CTF its free. Bind F3 as follows in your User.ini:
    F3=ShowObjectives | mutate smartctf showstats

    Now it will display the objectives during an Assault game and the SmartCTF statboard during a CTF game (compatible with older versions of SmartCTF).


    Contact

    Contact {DnF2}SiNiSTeR on #DutchNet @ QuakeNet IRC

    Or via the e-mail on this page.


    Original Readme