|
|
| Line 1: |
Line 1: |
| '''Spree Detector''' is a LUA script for etpro servers which provides killing spree messages as you may know them from [http://et.d1p.de/etadmin_mod/wiki/index.php/Main_Page etadmin_mod], [http://et.tjw.org/etpub ETPub] or [http://jaymod.clanfu.org/ Jaymod].
| |
|
| |
|
|
| |
| ==Installation==
| |
|
| |
| # [[User:Th/Spree_Detector#Downloads|Download]] the file '''spree.lua''' and put it in your '''etpro''' directory.
| |
| # Add ''spree.lua'' to your <code>lua_modules</code> cvar, example: <pre>set lua_modules "module.lua module2.lua spree.lua anothermodule.lua"</pre>
| |
| # Configure the script using the [[User:Th/Spree_Detector#cvars|listed cvars]] or use the [[User:Th/Spree_Detector#Sample_configuration|sample config]].
| |
|
| |
|
| |
| ==Sample configuration==
| |
|
| |
| This is a sample configuration for the script. It displays all sprees you may know from the etadmin_mod (killing spree, rampage, ...) and plays spree sounds. All messages are displayed on the top of the screen (banner area).
| |
|
| |
| set spree_defaultpos "bp"
| |
| set spree_announceends "1"
| |
|
| |
| set spree_end_selfkill "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He killed himself."
| |
| set spree_end_teamkill "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He was killed by ^1TEAMMATE ^7<KILLER>^7."
| |
| set spree_end_enemy "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He was killed by <KILLER>^7."
| |
| set spree_end_crush "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He crushed."
| |
| set spree_end_falling "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He fell to his death."
| |
| set spree_end_hurt "<VICTIM>^7's killing spree ended (<VCOUNT> kills). He was killed to death."
| |
|
| |
| set spree_message5 "<KILLER> ^7is on a killing spree (<KCOUNT> kills in a row)."
| |
| set spree_sound5 "sound/misc/killingspree.wav"
| |
|
| |
| set spree_message10 "<KILLER> ^7is on a rampage (<KCOUNT> kills in a row)."
| |
| set spree_sound10 "sound/misc/rampage.wav"
| |
|
| |
| set spree_message15 "<KILLER> ^7is dominating (<KCOUNT> kills in a row)."
| |
| set spree_sound15 "sound/misc/dominating.wav"
| |
|
| |
| set spree_message20 "<KILLER> ^7is unstoppable (<KCOUNT> kills in a row)."
| |
| set spree_sound20 "sound/misc/unstoppable.wav"
| |
|
| |
| set spree_message25 "<KILLER> ^7is godlike (<KCOUNT> kills in a row)."
| |
| set spree_sound25 "sound/misc/godlike.wav"
| |
|
| |
| set spree_message30 "<KILLER> ^7is wicked sick (<KCOUNT> kills in a row)."
| |
| set spree_sound30 "sound/misc/wickedsick.wav"
| |
|
| |
| set spree_message35 "<KILLER> ^7is real potter (<KCOUNT> kills in a row)."
| |
| set spree_sound35 "sound/misc/potter.wav"
| |
|
| |
|
| |
| ==cvars==
| |
|
| |
| '''spree_defaultpos'''
| |
| :The default position where message will be displayed, e.g. if <code>spree_end_position</code> or <code>spree_position5</code> aren't set. If this cvar isn't set, too, <code>bp</code> (banner print) is used.
| |
| :''Example:'' <code>set spree_defaultpos "qsay"</code>
| |
| '''spree_announceends'''
| |
| :This cvar controls whether spree ends are announced. Valid values are <code>1</code> (enabled) and <code>1</code> (disabled). The default value of this cvar is <code>1</code>.
| |
| :''Example:'' <code>set spree_announceends "0"</code>
| |
| '''spree_end_selfkill'''
| |
| :The message which will be displayed when a player within a spree killed himself.
| |
| :''Example:'' <code>set spree_end_selfkill "<VICTIM>^7's spree ended (<VCOUNT> kills). He killed himself."</code>
| |
| '''spree_end_teamkill'''
| |
| :The displayed message when a player within a spree got killed by a teammate.
| |
| :''Example:'' <code>set spree_end_teamkill "<VICTIM>^7's spree ended (<VCOUNT> kills). He was killed by ^1TEAMMATE ^7<KILLER>."</code>
| |
| '''spree_end_falling'''
| |
| :The displayed message when a player within a spree fell to his death.
| |
| :''Example:'' <code>set spree_end_falling "<VICTIM>^7's spree ended (<VCOUNT> kills). He fell to his death."</code>
| |
| '''spree_end_crush'''
| |
| :The displayed message when a player within a spree crushed.
| |
| :''Example:'' <code>set spree_end_crush "<VICTIM>^7's spree ended (<VCOUNT> kills). He crushed."</code>
| |
| '''spree_end_hurt'''
| |
| :The displayed message when a player within a spree was killed to death, e.g. barrier wires.
| |
| :''Example:'' <code>set spree_end_hurt "<VICTIM>^7's spree ended (<VCOUNT> kills). He was killed to death."</code>
| |
| '''spree_end_enemy'''
| |
| :The displayed message when a player within a spree got killed by an enemy.
| |
| :''Example:'' <code>set spree_end_enemy "<VICTIM>^7's spree ended (<VCOUNT> kills). He was killed by <KILELR>^7."</code>
| |
| '''spree_end_position'''
| |
| :The position where all the end messages will be displayed. Valid positions are ''bp'' (banner print), ''cp'' (center print), ''cpm'' (popup area) and ''qsay'' (player chat area). If no position is set, <code>spree_defaultpos</code> will be used.
| |
| :''Example:'' <code>set spree_end_pos "qsay"</code>
| |
| '''spree_message'''''n''
| |
| :This is the shown message when a player kills ''n'' players in a row.
| |
| :''Examples:'' <code>set spree_message5 "<VICTIM> ^7is on a killing spree (5 kills in a row)."</code>
| |
| :<code>set spree_message15 "<VICTIM> ^7is dominating (15 kills in a row)."</code>
| |
| '''spree_position'''''n''
| |
| :Use this to set the display position of a certain spree. If no position is set, <code>spree_defaultpos</code> will be used.
| |
| :''Examples:'' <code>set spree_position5 "bp"</code> and <code>set spree_position15 "qsay"</code>
| |
| '''spree_sound'''''n''
| |
| :You can specify a sound file which will be played for a certain spree.
| |
| :''Examples:'' <code>set spree_sound5 "sound/misc/killingspree.wav"</code>
| |
| :<code>set spree_sound15 "sound/misc/dominating.wav"</code>
| |
|
| |
|
| |
| ==Placeholders==
| |
|
| |
| You can use the following placeholders in your messages. They will be replaced with the actual value.
| |
| * <code><VICTIM></code> and <code><KILLER></code> - the playernames with [[Color_Codes|color codes]]
| |
| * <code><VICTIMNC></code> and <code><KILLERNC></code> - the playernames ''without'' [[Color_Codes|color codes]]
| |
| * <code><KCOUNT></code> and <code><VCOUNT></code> - the value of the killer's and victim's killcounter (K = killer, V = victim)
| |
|
| |
|
| |
| ==Downloads==
| |
| * '''[http://fooo.org/spree/spree.lua Spree Detector v0.1 (spree.lua)]''' - teh script (version 0.1)
| |
| * '''[http://fooo.org/spree/spree.cfg Sample Configuration (spree.cfg)]''' - you can use this as a template for your own config
| |
| * '''[http://fooo.org/spree/etadmin_sounds.pk3 etadmin_sounds.pk3]''' - pk3 containing the spree sounds
| |