Pireax: Created page with "Battlefield 2 provides for a Python "administrative" module; this module can do pretty much anything, but the Python code that ships with BF2 serves two basic roles: * It imp..."

2018-05-04T13:18:40Z

Created page with "Battlefield 2 provides for a Python "administrative" module; this module can do pretty much anything, but the Python code that ships with BF2 serves two basic roles: * It imp..."

New page

Battlefield 2 provides for a Python "administrative" module; this module can do pretty much anything, but the Python code that ships with BF2 serves two basic roles:

* It implements the BF2 RCon ("Remote Console") interface
* It implements several in-game automatic administration functions; the standard module automatically balances the number of players on each team, and handles punishment of players for killing teammates ("TK"ing).

The <code>sv.adminScript</code> server configuration directive tells the BF2 game engine which administrative module should be loaded as the engine is starting up; this directive gives the name of the Python module to load in the <code>Battlefield 2 Server/admin</code> directory; the default administrative module that ships with BF2 is called, appropriately, <code>default</code>:

<pre> sv.adminScript "default" </pre>

You can create your own administrative modules; just put them in the <code>Battlefield 2 Server/admin</code> directory and change the setting for <code>sv.adminScript</code> in the <code>ServerSettings.con</code> file. One example of a custom administrative module can be found [[Scripts:Modified_admin_script|here]] (in this case, it's an expansion of the <code>default</code> module that adds more features).

== Module Methods ==

Any administrative module, including <code>default</code>, has three methods which are called by the game engine itsef:

; init()
: The game engine calls this method while it is [[Big_Picture|starting up]]; in the <code>default</code> module, this method reads the admin configuration file (<code>default.cfg</code>), initializes the admin system, registers to receive [[Event_Reference#Command_Events|RemoteCommand]] events, etc.
; shutdown()
: The game engine calls this method when the server is shutting down (shutting down completely--not just after each game round). In the <code>default</code> module this method just closes the TCP socket used for receiving RCon commands from the network.
; update()
: The game engine calls this method roughly every 30ms; in the <code>default</code> module, this method checks for any new input arriving over the network TCP RCon socket.

== RCon ==

BF2 includes an "RCon" (Remote Console) function that allows many administrative functions that can be done from the regular console (the black-and-white curses interface on the machine running the BF2 server) to be done from a "remote console"--either from within a BF2 game client (accessed by a player pressing the "~" key), or via a TCP network interface.

The RCon interface is implemented completely in Python, with the code in the <code>Battlefield 2 Server/admin</code> directory. The game engine provides five facilities that this Python code uses:

* As part of it's [[Big_Picture|start-up procedure]], the server imports the Python module in the <code>admin</code> directory specified by the <code>sv.adminScript</code> directive. This is normally the <code>default</code> module, but the fact that it's imported based on a configuration directive means that it could easily be changed to a custom module.
* The game engine provides an event, [[Event_Reference#Command_Events|RemoteCommand]], that fires whenever an in-game player accesses their console and types any line beginning with "rcon". The event passes any registered callback handlers the actual command typed by the player. This is how the <code>default</code> module receives RCon commands from players (but it can be used by other Python code, as well).
* The game engine provides a method, <code>host.rcon_feedback</code>, that can be used to send messages to a player's in-game console. This is what the <code>default</code> module uses to send responses to players' RCon commands back to them (but it can be used by other Python code, also).
* The game engine calls the <code>update</code> method of the <code>default</code> module (or whatever module has been specified by <code>sv.adminScript</code>) repeatedly, generally about every 30 milliseconds (roughly 30 times per second). The <code>default</code> module uses this to run a fast check for input on a TCP port (normally port 4711) for RCon commands--this is how the network RCon interface receives commands. More information about the RCon protocol the <code>default</code> module implements can be found in the [[RCon_Protocol|RCon Protocol Specification]]
* When the <code>default</code> module decides to execute a console command from a remote user, it passes it on to the game engine for execution using the <code>host.rcon_invoke</code> method. This method isn't specific to RCon commands--in fact, it doesn't execute RCon commands at all--it executes server console commands, and can be used to good effect by any Python code. Note, however, that there is presently a bug in BF2 that prevents any feedback from PunkBuster commands from being sent back to the caller of <code>host.rcon_invoke</code>; since this is the only way remote console commands are executed, it means that RCon users can never see any feedback from PunkBuster commands they send via RCon.

The <code>default</code> module implements just three RCon commands (but could easily be extended to add others):

; login <password>
: <code>default</code> won't accept any other RCon commands until this command is given with the valid password, as specified in the <code>default.cfg</code> file.
; users
: lists players connected to the server, along with their [[Player_Identity#IP_address|IP Addresses]] and [[Player_Identity#CD_Key_Hash|CD key hashes]]. [edit by cyber37 (i don't delete last sayed) no it's not that when you unter users the server send to you the ip of admins who are using the rcon protocol for the server]
; exec <server command>
: executes any server command.

(Note that from a player's in-game console window, each of these commands must be preceeded by the word "rcon" to cause the game engine to send it to the <code>default</code> module; from a TCP RCon connection, these commands are typed exactly as shown).

== Other Administrative Functions ==

When the game engine imports the <code>default</code> administrative module, one of the things the module does is to import the <code>standard_admin</code> module. When <code>standard_admin</code> is imported, it in turn imports and initializes two other modules:

* standard_admin.autobalance
* standard_admin.tk_punish

Admin Module - Revision history

Pireax: Created page with "Battlefield 2 provides for a Python "administrative" module; this module can do pretty much anything, but the Python code that ships with BF2 serves two basic roles: * It imp..."