Login   Register  
PHP Classes
elePHPant
Icontem

File: README

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Shannon Wynter  >  Valve RCON  >  README  >  Download  
File: README
Role: Documentation
Content type: text/plain
Description: Readme file
Class: Valve RCON
Manage remote game servers via RCON protocol
Author: By
Last change:
Date: 6 years ago
Size: 2,077 bytes
 

Contents

Class file image Download
Valve RCON Class.
-------------------

Version 1.0

Author: Shannon Wynter (http://fremnet.net/contact)
			Copyright (C) Shannon Wynter & Fremnet.net

License: GPL 2.0 or greater

The php5 version of my original RCON class for making use of the remote console
facilities on various game servers.

Basic Synapsis:
-------------------
There are two ways to use this class, one is the more traditional lazy method as
implemented by other functions/classes availible on the net, the other is a stricter
method that requires you to do your own connecting and authenticating.

There is a performance penalty for using the traditional method over multiple
commands in that it has to connect, and authenticate every single time.

So my general advice, use the general usage method as described below if you have
to execute more then a couple of commands

** General Usage:
include('valve_rcon.php');
$r = new Valve_RCON('secret', '121.45.193.22', 27015, Valve_RCON::PROTO_SOURCE);
$r->connect();
$r->authenticate();
print $r->execute('status');
print $r->execute('kick user');
$->disconnect();

** Traditional Lazy Usage:
include('valve_rcon.php');
$r = new Valve_RCON('secret', '121.45.193.22', 27015, Valve_RCON::PROTO_SOURCE);
print $r->execute('status');

Full Documentation:
-------------------

You can generate full documentation by making sure you have
phpDocumentor installed and running the document.sh file found in
this directory

License:
-------------------

This library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.