================================================================
Title                   : Rol Ancient's Rune Control v1.0 
Version                 : 1.00
Release Date            : Mar 19 2001
Filename                : Rarcv.zip
Author(s)               : Robin "Rol Ancient" Lyngsdal
Email Address           : Rol000@bigfoot.com
Description             : Votekick and MOTD mutator for Rune
Additional Credits to   : Tristan Norad and the other guys who made Nordic Storm
			  for showing me with their me how to make windows in Rune.
================================================================

Instalation Instructions:
-------------------------

-Extract the files to your ../rune/system Folder


-It may be necessary to add the following to your Rune.ini to host games.

		Under [Engine.GameEngine] add the line.

			Serverpackages=RARCV1


To use it in your game, choose it as a mutator under the mutator tab in the server setup

Note: If you have the Beta version of Votekick installed please delete all the files from that
      version, since it may cause problems with this version. And remove any reference to that
      mutator from your Rune.ini.

	Files to delete:  votekick.u
			  votekick.int 
			  votekick.ini

The package contains the following files:
-----------------------------------------
RARCV1.u	: The compiled code
RARCV1.int	: The mutator class definition
RARCV1.ini	: The Settings for the mutator (see below)
RARCV1.txt	: This File


Mutator Description:
--------------------
This mutator has 3 functions at present:

- It adds a MOTD window that apears when players log on and at level change,
  it requires the player to agree to any rules posted as the message of the 
  day, if he/she doesnt he/she will not be allowed to play.

- It lets the players intitiate 2 types of votes against other players, that has to 
  be passed with a configurable majority.(cannot be against admins btw.)
		- kick Vote	: kicks player
		- Statue Vote	: Turns the player into a statue, the player is made
				  of stone, cannot move and cannot take dammage.
				  (lasts till the level change or the player logs of)

- Finaly it lets any player who is logged on as admin perform any of the above vote results
  instantly.

Mutator Usages:
---------------

The MOTD window just pops up automaticly with a predifined text, if the player doesnt push
the agree button or the corresponding key, he/she will get kicked. 
Setting up the MOTD see settings below.

The voting and admin kick/statue is chosen through a menu, to call up the menu you have to 
Bind a key to the following.

"mutate mmenu"

It can either be done through the advanced options or by typing 

"set input <key> mutate mmenu"

in the Rune console.

It is also possible to access the menu directly through the Rune console by 
typing "mutate mmenu", but only thorugh the Console, the Tab console will NOT work
For this, since it closes the Rune Console when you hit return.

When you open the window, the player you want to start a vote against will be listed
in the two pulldown menus at the top, and if theres a vote in progress two buttons
will apear that allows you to vote.

Note: Not voting is the equivelant of voting No, theres no need to vote No unless you want
      to change your previusly recorded vote.


Mutator settings:
-----------------

The following variables can be set.

bAllowVoting		:	Set to TRUE if you want the players to be able to initiate votes.

bShowMOTD		:	Set to TRUE if you want the MMOTD window to apear

voteTime		:	The time in seconds that has to elapse before a vote is called of if theres no decision

Votepercent		:	The percentage of players that has to vote yes to a given vote for it to be accepted

bAllowStatue		:	Set to True if the players are alowed to initiate statue votes

bAllowKick		:	Set to True if the players are alowed to initiate kick votes

MOTD1-MOTD10		:	Here the owner of the server can type in the MOTd that will apear in the MOTD window

Changing the settings:
----------------------

There are two ways to change the mutators settings.

- open the Rarcv.ini file and change the settings there. Must be done before starting rune

- Use the following command in the Rune console

	Set Rarcv1 <variable> <amount>

ex. 	Set <Rarcv1 voteTime 20> will set the votetime to 20 seconds


Word of caution:
----------------

Currently the only players who are immune to votes are players that are logged on as admins.
This means that if you just start a listen server and dont log on as admin you are open
to votes and ,yes, it is possible to be kicked from your own server.
In addition whenever a map change you will lose your admin status and again be open to votes.

Known Bugs.
-----------

-Theres a slight chance that if 2 players log on VERY close to each other (within 2 ticks)
 the first of them wont get a MOTD on window, actually i think its a purely theoretical chance
 but im not 100% sure.

-If you use this mutator in with gametypes that uses custom Huds, the vote countdown wont apear
 on the Hud. It was either that or overriding the custom Huds.

 
To Do:
------

This is basicly just a polished version of the beta version, with the MOTD option added,
there are a lot of stuff I'd like to add when I find the time.

-More vote types
-Admin kickban menu
-Admin Configuration menu, both for this mutator, for some of the basic Rune options and
 maybe for other mutators
-limited player initiated kickban (until the map change)
-Admin Summon menu
-Map change vote
-Gametype change vote
-and so on.

Feedback:
---------
Since this is only my second mutator, and the first one I have made from scratch, Id really 
appreciate any feedback whether in the form of suggestions, bugreports and/or comments.

If you have any feedback please mail to:

Rol000@bigfoot.com

Legal Stuff:
------------

Well the copyright is basicly mine aside from whatever copyright Epic or HH has in conjunction
with Runeed and its scripts, But if you feel a need to use any of the code for your own
purposes, I wont mind, as long as I get credit for the stuff you use.

(C) Robin "Rol Ancient" Lyngsdal 2001. 



