Difference between revisions of "Spree Module"

Latest revision as of 02:53, 30 November 2005

spree 1.5 [smong 24/11/04]

-Compiling
Linux: make -f spree.mk
Win: .dll project (add util.c, zlib.lib, pthread.lib if necy)

-Installation
Put spree.so/.dll in bin/.
Put spree.conf in conf/spree.conf
Put spree:spree at the bottom of conf/modules.conf
Append spree to the AttachModules of each arena that you want to use with spree
Put #include conf/spree.conf at the bottom of your arena.conf

[Modules]
AttachModules =     \
	fm_normal   \
	points_kill \
	spree

Append cmd_spree and privcmd_spree to conf/groupdef.dir/default if you wish to
enable the ?spree command

-Customisation
Edit spree.conf:

[Spree]
ResetSpreeOnFrequencyChange=0
  ;Changing freq resets the spree (default=0)
ResetSpreeOnShipChange=0
  ;Changing ship resets the spree (default=0)
ResetSpreeOnFlagWin=0
  ;Everyone's spree is reset when the flag game is won (default=0)
SpreeEndMinimum=4
  ;If a player on a spree has this many kills and dies..
  ;(default=65535)
SpreeEndMessage=has had their spree cut short
  ;..this message will be displayed..
SpreeEndBong=22
  ;..and this bong played. (default=0)
  ;<name> <SpreeEndMessage> <%SpreeEndBong>
  
Message3=%killer is dominating (3:0)
  ;On 3 consecutive kills, this message will be displayed
Bong3=13
  ;This bong will be played with the message (default=0)
  ;<name> <Message#> <%Bong#>

PlayerObject3=100
  ;toggles this object on for the killer only
ArenaObject3=101
  ;toggles this object on for the whole arena

All the settings are optional. But there are no built in Message#, so attaching
spree to an arena without #include'ing conf/spree.conf won't do much. # can
safely go up to 9999 in theory. Spree messages are sent as arena messages.

%macros that can be used in Message#:
killer, killed, bounty, coord

See Installing_New_Modules.