===========================================================================
MatchMod v0.90 Beta

  http://djeyl.net/m4

---------------------------------------------------------------------------
CONTENTS

- ABOUT
- REQUIREMENTS
- INSTALLATION
- USING M4
- CONTACT
- CREDITS

---------------------------------------------------------------------------
ABOUT

M4 (MatchMod for MetaMod) is software geared towards clan matches ; it
brings anything needed to run matches : detects which team players belong
to, assigns them to the right side (Terrorist or CT), warm-ups, waits for
players to be ready, first half, switches teams, second half, optionally
overtime...

In 'full' mode, a MySQL database is used to store your matches data, that
you can administrate with a web interface.

A 'light' mode is also available, that allows you to benefit from m4
in-game functionalities if you don't have or want MySQL and php web servers
(generally the case for online rented servers).

---------------------------------------------------------------------------
REQUIREMENTS

* Game servers :
 Half-Life 1.1.1.0 (HLDS 4.1.1.0 for Windows and 3.1.1.0 for Linux)
 Counter-Strike 1.5
 MetaMod v1.13

* Web server :
 Apache 1.3 (reported to work on 1.3.12, 1.3.19, 1.3.22) -- IIS untested
            (we DO NOT guarantee anything with Apache 2.x !)
 PHP 4 (worked with 4.0.1pl2, 4.0.6, 4.1.1, 4.2.1, 4.2.2)

* Database server :
 MySQL 3.23 (worked on 3.23.22-beta-log, 3.23.42-nt, 3.23.41)

---------------------------------------------------------------------------
INSTALLATION

Uncompress ZIP archive.

The following folders are created :
- cstrike : files to copy to cstrike folder
            (cstrike/addons/m4 subfolder)
- php     : php interface, to put on a web server ('full' mode)
- sql     : database dump file to import ('full' mode)
- linux   : linux sample scripts to run hlds
            (copy to hlds_l directory)
- windows : windows sample scripts
            (copy to same folder as hlds.exe)

Don't forget to declare m4 .dll / .so file in MetaMod's plugins.ini (where
other plugins like AdminMod, StatsMe or HLGuard might already be) that's
in cstrike/addons/metamod directory.

Take a look at config files :
- game server : cstrike/addons/m4/*.cfg
- web server  : config.php

Add this to your hlds command line :
	+serverinfo m4_server X
where X is the server's identifying number for M4 (cf. interface).

At last, use phpMyAdmin or MySQL command line client to import sql/m4.sql

Good luck !...

---------------------------------------------------------------------------
USING M4

Note : 'light' mode : please refer to M4-Light.txt


Well, if you've successfully installed it, you probably won't have problems
using it... take a look at your web interface, should be easy :-)
Please note it requires your game servers to be running.

(Please remember it's only a beta version)

You must authenticate to access administrative features (password box on
the left).


What players have to do :

Add the following line to their config.cfg :

	setinfo clan X

where X is the number identifying their team.

If their clan is configured with a password, they specify it right after,
separating it from clan number with one of the following characters :
: . , - _ / <space>

Examples :

	setinfo clan "1:mypass"
	setinfo clan 2.superpass

I'd personally choose '.' because it doesn't require to add quotes.


Players also have to bind a key to the word you specified in the interface :
(default : m4)

	bind F3 m4

To play a match, they just have to connect to the right server (that has
a special hostname : "Team1 vs Team2". They're automatically assigned to
the right team (Terrorists or CT), and have to choose their skin.

Then warm-up begins :
- either they wait for X minutes (you specified in config)
- or they all say they're ready, hitting m4 key or saying m4 command

Then they're warned and the server double-restarts the game.

During the match, m4 key can be used to display current score.

When the first half have been played, teams are switched and m4 launches
second half of the match after 1'30".

If scores are tied, overtimes are played (3+3 rounds) until a team wins the
match.

At the end of a match, m4 displays total scores : players can disconnect.
Server reloads the map in a normal public state 90 seconds later if you
didn't click on "normal" on the web interface.




Don't hesitate to say what you think of m4, report bugs and tell what
features would be great to be added. Just send an e-mail or visit
m4 forums !

---------------------------------------------------------------------------
CONTACT

Mail  : m4@djeyl.net
Site  : http://djeyl.net/m4
Forum : http://djeyl.net/forum - http://djeyl.net/forum/viewforum.php?f=29

---------------------------------------------------------------------------
CREDITS

Plugin MetaMod & PHP Interface by dJeyL
Thanks to StalkR, Apophyss, Noplay & Bud-Froggy for their precious help ;-)
Thanks to DoubleHelix from ukcsr.com for beta testing & proof-reading v0.90
Thanks to MrKill from SoGamed.com for his interview, support & friendship

===========================================================================
