BF2 Technical Information Wiki - User contributions [en]

BF2 Internals

2019-01-26T23:05:54Z

Pireax:

The BF2 engine has been written in C++ and also make heavy use of STL.

{{tip}} All virtual functions on this page are in the order they are defined in the vtable unless otherwise specified.

== Reference Counting ==
A lot of the internal components of the game use intrusive reference counting through inheritance.
The base class would look something like this:
<pre>
class RefCounted {
public:
RefCounted() : m_refCount(1) {}

virtual int addRef() {
return ++m_refCount;
}

virtual int getRefCount() const {
return m_refCount;
}

// Unsure if there actually is a base implementation of this method,
// this sometimes points to a unique function in the vtable but follows this pattern.
virtual int release() {
if (--m_refCount == 0) {
delete (RefCounted*)this;
}
return m_refCount;
}

// Position of the destructor in the vtable may change.
virtual ~RefCounted() {}
private:
int m_refCount;
};
</pre>
Do note that this class is not thread-safe, as in the actual implementation.

== ClassManager ==
The program contains a single ClassManager instance which is used to dynamically access different subsystems within the game.
These subsystems are registered via a string identifier(class name), an instance pointer, the class id and another unknown integer, they can then later be accessed using the class name.
The following classes are registered in BF2.exe:
; GameServerSettings
; HudInformationLayer
; DistributedLightRenderer
; LocalProfileManager
; ProfileManager
; RankManager
; ClanManager
; NewsManager
; AutoPatch
; Persistence
; MenuTeamManager
; GlobalSettings
; VideoSettings
; AudioSettings
; ControlSettings
; GeneralSettings
; HapticSettings
; ServerBrowserManager
; SwiffHost
; DemoLibrary
; ServerLogoManager
; ModInfo

The rendering module(RendDX9.dll) also registers the following classes:
; SwiffRenderer
; Terrain
; LightManager
; GeometryTemplateManager
; StaticMeshRenderer
; SkinnedMeshRenderer
; ParticleSystemManager
; HemiMapManager
; DecalManager
; DecalShadowManager
; RoadCompiledRenderer
; RoadEditableRenderer
; NametagManager
; SkyDome
; UndergrowthSystem
; LightingManager
; WeatherManager
; RainManager
; RenderView
; EnvMapManager

== Common ==
=== GameEvent ===
The game has multiple event systems, game events are events that occur in-game and are related to gameplay.
The (incomplete) class below is the base class used by all events, events often have additional data.
A GameEvent has a maximum size of 1024 bits as defined by <code>const uint MaximumGameEventSize</code>.
<pre>
class GameEvent : public RefCounted {
public:
GameEvent() : field_8(-1) {}

// multiple virtual functions here
private:
int field_8;
};
</pre>
List of Game events:
; ChallengeEvent
; ChallengeResponseEvent
; ConnectionTypeEvent
; DataBlockEvent
; CreatePlayerEvent
; CreateObjectEvent
; CreateKitEvent
; DestroyObjectEvent
; DestroyPlayerEvent
; EnterVehicleEvent
; ExitVehicleEvent
; PostRemoteEvent
; ChangePlayerNameEvent
; HandlePickupEvent
; HandleDropEvent
; StringBlockEvent
; JoinSquadEvent
; LeaveSquadEvent
; CommanderEvent
; RadioMessageEvent
; KilledByEvent
; ChangeSquadNameEvent
; SetPrivateSquadEvent
; IssueSquadOrderEvent
; InviteEvent
; RankEvent
; KickBanEvent
; SetAcceptOrderEvent
; SetSquadLeaderEvent
; SpottedEvent
; ArtilleryEvent
; StickyProjectileEvent
; AmbientEffectAreaEvent
; VoipOnOffEvent
; CommanderCamEvent
; SupplyDropEvent
; VoidPlayerMuteEvent
; VoteEvent
; TargetDirectionEvent
; BeginRoundEvent
; EndOfRoundEvent
; PythonCommandEvent
; RequestEvent
; VoipSessionEvent
; ToggleFreeCameraEvent
; MedalEvent
; UnlockEvent
; MissileInitEvent
; UAVEvent
; ContentCheckEvent
; DropVehicleEvent
; CreateSpawnGroupEvent
; RemoveSpawnGroupEvent
; UpdateTriggerEvent
; GrapplingHookContainerCreateEvent
; GrapplingHookContainerUpdateEvent
; GrapplingHookContainerDetachEvent
; GrapplingHookCreateEvent
; GrapplingHookUpdateEvent
; PlayerTearGassedEvent
; SetNightVisionEvent
; VerifyPlayerTeamEvent
; FixPlayerTeamEvent

== IO ==
Access to the filesystem is done through the FileManager accessible through the ClassManager.

=== Stream ===
Interface used for files, used by FileManager.
<pre>
class Stream {
public:
virtual unsigned read(void* buffer, unsigned numBytes) = 0;
virtual bool write(void* buffer, unsigned numBytes) = 0;
virtual int unk_1() {};
virtual int unk_2() {};
virtual Stream clone() = 0;
virtual int unk_3() {};
virtual int unk_4() {};
virtual int unk_5() {};
virtual bool seek(unsigned moveMethod, long distanceToMove) = 0;
virtual unsigned getPosition() = 0;
virtual unsigned getSize() = 0;
};
</pre>
=== FileSystem ===
Interface used and implemented by the FileManager to access the underlying file system.
<pre>
class FileSystem {
public:
virtual int unk_1() {}
virtual int unk_2() {}
virtual Stream* openFile(std::string* path) = 0;
virtual int unk_3() {}
virtual int unk_4() {}
virtual int unk_5() {}
virtual int unk_6() {}
virtual bool readFile(std::string* path, void* buffer, unsigned numBytes, unsigned* bytesRed) = 0;
virtual int unk_7() {}
virtual int findFiles(std::string* folderPath, ? a, ? b) = 0;
virtual int getFileInfo(std::string* path, ? a) = 0;
virtual int compareFileTime(std::string* path, std::string* otherPath) = 0;
virtual bool getFullFileName(std::string* path) = 0;
virtual void update() = 0;
};
</pre>

File Formats

2018-12-29T21:33:13Z

Pireax: /* terraindata.raw */

=== Image Files ===
The majority of the image files within the Battlefield 2 directory structure have the '''PNG''' file extension, however most of these image files are in fact '''DDS''' files with an incorrect file extension. There are a few image files that really are PNG files (mainly within <tt>Battlefield 2\mods\bf2\Objects\</tt>), and can be easily loaded by an image viewer/editor.

The image files in Menu_client.zip are packed into a DDS Texture Atlas file. Basicly, an atlas file combines a lot of small images into one big image to improve reading performance. An index file with coordinates is used to locate the individual images in the Atlas.
The Atlas images and index files are located in Menu_client.zip/Atlas.

=== Basic File Format Data Types ===
==== String ====
<syntaxhighlight lang="c">
struct String {
uint len;
char cstr[len];
};
</syntaxhighlight>

==== Vec2 ====
<pre>
struct Vec2 {
float x;
float y;
}
</pre>

==== Vec3 ====
<pre>
struct Vec3 {
float x;
float y;
float z;
}
</pre>

==== Point ====
<pre>
struct Point {
float x;
float y;
float z;
}
</pre>

==== Mat4 ====
<pre>
struct Mat4 {
float m[4][4];
}
</pre>

==== Axis-Aligned Bounding Box ====
Used for collosion detection.
<pre>
struct AABB {
Point endpoint1;
Point endpoint2;
}
</pre>

=== Mesh File Formats ===
A mesh describes how an object in the world needs to be rendered, all mesh file formats use little endian byte order.

==== Common Mesh Data Types ====
===== Header =====
<pre>
struct Header {
uint u1;
uint version;
uint u2; // not used
uint u3; // not used
uint u5; // not used
char u6; // not used
}
</pre>

===== VertexElement =====
<pre>
struct VertexElement {
ushort flag;
ushort offset;
ushort varType;
ushort usage;
}
</pre>

===== Geometry =====
<pre>
struct Geometry {
uint numGeom; // number of geometric objects in this file
uint numLods[numGeom];
uint numVertexElements;
VertexElement vertexElements[numVertexElements]; // based on D3DXVERTEXELEMENT9
uint vertexFormat;
uint vertexStride;
uint numVertices;
float vertices[numVertices * (vertexStride / vertexFormat);
uint numIndices;
ushort indices[numIndices];
}
</pre>

==== .staticmesh File Format ====
The .staticmesh format is used for meshes without animations, below is a description of the file layout in a C like syntax.
<pre>
struct StaticMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes;
Mat4 nodes[numNodes]; // nodes are the respective origins of the objects?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
Vec3 u4;
Vec3 u5;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .bundledmesh File Format ====
<pre>
struct BundledMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes; // not used?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .skinnedmesh File Format ====
<pre>
struct SkinnedMesh {
Header header;
Geometry geometry;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numRigs;
struct Rig {
uint numBones;
struct Bone {
uint id;
Mat4 mat; // inverse bone matrix
} bones[numBones];
} rigs[numRigs];
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .mesh File Format ====
It seems that .mesh files are only used for road data. Note that this file has a different layout.
<pre>
struct RoadCompiled {
uint version; // version number consists of major and minor version, latest is 65540, 65540 >> 16 = 1, 65540 % 65536 = 4 (v1.4)
Vec3 u1;
uint u2;
Vec3 u3;
Vec3 u4;
uint u5;
uint numVertices;
struct {
Vec3 pos;
Vec2 tex0;
Vec2 tex1;
uint alpha;
} vertices[numVertices];
uint numIndices;
ushort indices[numIndices];
uint numUnk;
struct {
uint u1;
uint u2;
uint u3;
Vec3 u4;
} unk[numUnk];
}
</pre>

=== terraindata.raw ===
The terraindata.raw file describes the terrain of a level in BF2.
<pre>
struct TerrainData {
uint version;
Vec3 primaryWorldScale;
Vec3 secondaryWorldScale;
float u1;
float u2;
float u3;
uint patchSize;
bool subdividePatches;
uint numPatches;
uint patchColormapSize;
uint lowDetailmapSize;
char* colorMapbaseName; // the following strings use a newline character ('\n') as terminator instead of the normal null terminated C string
char* detailMapbaseName;
char* lowDetailMapbaseName;
char* lightmapBaseName;
Vec2 farSideTiling;
float farSideTilingHi;
float farSideTilingLow;
float farYOffset;
Vec3 terrainSunColor;
Vec3 terrainSkyColor;
Vec3 terrainWaterColor;
uint numLayers; // This is always 6 for BF2, these are the layers as found in the terrain editor
struct {
char* detailTexturePath;
char planeMap;
Vec2 sideTiling;
float topTiling;
float yOffset;
bool envMap;
} layers[numLayers];
uint u6[38 * 21]; // used by TerrainCuller
uint u7[6 * 64]; // used by TerrainCuller
uint numLodIndices;
ushort lodIndices[numLodIndices];
bool vertexFormat;
struct QuadPatch { // This describes a rectangular region of the main terrain
int x;
int y;
uint u3;
uint u4;
Vec3 position;
uint u6;
struct {
D3DCOLOR pos0;
float pos1;
Vec3 morphData;
D3DCOLOR normal;
} compactVertexData[(patchSize + 1) * (patchSize + 1)];
struct {
int magic;
uint index;
Vec3 zero1; // always 0/0/0, no longer in use?
float zero2; // no longer in use?
uint numChartIndices;
uint numChartIndicesDiv3; // this is equal to numChartIndices / 3
uint four; // always the value 4
uint numSubIndexQuads;
struct SubIndexQuad {
uint u1;
uint u2;
uint u3;
uint u4;
uint u5;
uint u6;
} subIndexQuads[numSubIndexQuads];
ushort chartIndices[numChartIndices];
} detailCharts[]; // this array is terminated like a string, it ends when the magic field of the next detail chart is -1
uint terminator; // this will be -1, see above comment
} patches[numPatches * numPatches];
// here should be the data for the surrounding terrain and maybe some other data, not yet clear.
}
</pre>

=== External Links ===
[http://msdn.microsoft.com/library/default.asp?url=/library/en-us/directx9_c/directx/graphics/reference/DDSFileReference/ddsfileformat.asp Microsoft Developer Network DDS File Reference]

[http://www.libpng.org/pub/png/ PNG File Information]

[http://eliteforce2.filefront.com/file/DDS_Converter;29412 DDS File Convertor]

[http://developer.nvidia.com/object/photoshop_dds_plugins.html Nvidia DDS Plugin for reading and writing DDS files in Adobe Photoshop]

[http://developer.nvidia.com/object/texture_atlas_tools.html Nvidia texture atlas tools reading and creating tool]

File Formats

2018-12-22T01:38:50Z

Pireax: /* terraindata.raw */

=== Image Files ===
The majority of the image files within the Battlefield 2 directory structure have the '''PNG''' file extension, however most of these image files are in fact '''DDS''' files with an incorrect file extension. There are a few image files that really are PNG files (mainly within <tt>Battlefield 2\mods\bf2\Objects\</tt>), and can be easily loaded by an image viewer/editor.

The image files in Menu_client.zip are packed into a DDS Texture Atlas file. Basicly, an atlas file combines a lot of small images into one big image to improve reading performance. An index file with coordinates is used to locate the individual images in the Atlas.
The Atlas images and index files are located in Menu_client.zip/Atlas.

=== Basic File Format Data Types ===
==== String ====
<syntaxhighlight lang="c">
struct String {
uint len;
char cstr[len];
};
</syntaxhighlight>

==== Vec2 ====
<pre>
struct Vec2 {
float x;
float y;
}
</pre>

==== Vec3 ====
<pre>
struct Vec3 {
float x;
float y;
float z;
}
</pre>

==== Point ====
<pre>
struct Point {
float x;
float y;
float z;
}
</pre>

==== Mat4 ====
<pre>
struct Mat4 {
float m[4][4];
}
</pre>

==== Axis-Aligned Bounding Box ====
Used for collosion detection.
<pre>
struct AABB {
Point endpoint1;
Point endpoint2;
}
</pre>

=== Mesh File Formats ===
A mesh describes how an object in the world needs to be rendered, all mesh file formats use little endian byte order.

==== Common Mesh Data Types ====
===== Header =====
<pre>
struct Header {
uint u1;
uint version;
uint u2; // not used
uint u3; // not used
uint u5; // not used
char u6; // not used
}
</pre>

===== VertexElement =====
<pre>
struct VertexElement {
ushort flag;
ushort offset;
ushort varType;
ushort usage;
}
</pre>

===== Geometry =====
<pre>
struct Geometry {
uint numGeom; // number of geometric objects in this file
uint numLods[numGeom];
uint numVertexElements;
VertexElement vertexElements[numVertexElements]; // based on D3DXVERTEXELEMENT9
uint vertexFormat;
uint vertexStride;
uint numVertices;
float vertices[numVertices * (vertexStride / vertexFormat);
uint numIndices;
ushort indices[numIndices];
}
</pre>

==== .staticmesh File Format ====
The .staticmesh format is used for meshes without animations, below is a description of the file layout in a C like syntax.
<pre>
struct StaticMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes;
Mat4 nodes[numNodes]; // nodes are the respective origins of the objects?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
Vec3 u4;
Vec3 u5;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .bundledmesh File Format ====
<pre>
struct BundledMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes; // not used?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .skinnedmesh File Format ====
<pre>
struct SkinnedMesh {
Header header;
Geometry geometry;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numRigs;
struct Rig {
uint numBones;
struct Bone {
uint id;
Mat4 mat; // inverse bone matrix
} bones[numBones];
} rigs[numRigs];
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .mesh File Format ====
It seems that .mesh files are only used for road data. Note that this file has a different layout.
<pre>
struct RoadCompiled {
uint version; // version number consists of major and minor version, latest is 65540, 65540 >> 16 = 1, 65540 % 65536 = 4 (v1.4)
Vec3 u1;
uint u2;
Vec3 u3;
Vec3 u4;
uint u5;
uint numVertices;
struct {
Vec3 pos;
Vec2 tex0;
Vec2 tex1;
uint alpha;
} vertices[numVertices];
uint numIndices;
ushort indices[numIndices];
uint numUnk;
struct {
uint u1;
uint u2;
uint u3;
Vec3 u4;
} unk[numUnk];
}
</pre>

=== terraindata.raw ===
The terraindata.raw file describes the terrain of a level in BF2.
<pre>
struct TerrainData {
uint version;
Vec3 primaryWorldScale;
Vec3 secondaryWorldScale;
float u1;
float u2;
float u3;
uint patchSize;
bool subdividePatches;
uint numPatches;
uint patchColormapSize;
uint lowDetailmapSize;
char* colorMapbaseName; // the following strings use a newline character ('\n') as terminator instead of the normal null terminated C string
char* detailMapbaseName;
char* lowDetailMapbaseName;
char* lightmapBaseName;
Vec2 farSideTiling;
float farSideTilingHi;
float farSideTilingLow;
float farYOffset;
Vec3 terrainSunColor;
Vec3 terrainSkyColor;
Vec3 terrainWaterColor;
uint numLayers; // This is always 6 for BF2, these are the layers as found in the terrain editor
struct {
char* detailTexturePath;
char planeMap;
Vec2 sideTiling;
float topTiling;
float yOffset;
bool envMap;
} layers[numLayers];
uint u6[38 * 21]; // used by TerrainCuller
uint u7[6 * 64]; // used by TerrainCuller
uint numIndices;
ushort indices[numIndices];
bool vertexFormat;
struct QuadPatch { // This describes a rectangular region of the main terrain
uint u1;
uint u2;
uint u3;
uint u4;
Vec3 u5;
uint u6;
struct {
float u1;
float u2;
float u3;
float u4;
uint u5;
uint u6;
} compactVertexData[(patchSize + 1) * (patchSize + 1)];
struct {
int magic;
uint i;
Vec3 zero1; // always 0/0/0, no longer in use?
float zero2; // no longer in use?
uint numChartIndices;
uint numChartIndicesDiv3; // this is equal to numChartIndices / 3
uint four; // always the value 4
uint numSubIndexQuads;
struct SubIndexQuad {
uint u1;
uint u2;
uint u3;
uint u4;
uint u5;
uint u6;
} subIndexQuads[numSubIndexQuads];
ushort chartIndices[numChartIndices];
} detailCharts[]; // this array is terminated like a string, it ends when the magic field of the next detail chart is -1
uint terminator; // this will be -1, see above comment
} patches[numPatches * numPatches];
// here should be the data for the surrounding terrain and maybe some other data, not yet clear.
}
</pre>

=== External Links ===
[http://msdn.microsoft.com/library/default.asp?url=/library/en-us/directx9_c/directx/graphics/reference/DDSFileReference/ddsfileformat.asp Microsoft Developer Network DDS File Reference]

[http://www.libpng.org/pub/png/ PNG File Information]

[http://eliteforce2.filefront.com/file/DDS_Converter;29412 DDS File Convertor]

[http://developer.nvidia.com/object/photoshop_dds_plugins.html Nvidia DDS Plugin for reading and writing DDS files in Adobe Photoshop]

[http://developer.nvidia.com/object/texture_atlas_tools.html Nvidia texture atlas tools reading and creating tool]

Scripts:ReservedSlots

2018-07-02T19:28:39Z

Pireax:

A small script to make sure there will always be a few reserved slots for certain players. If a non approved nick logs on and the server has reached its limit, that player will be kicked immediately.

This script should be run as the autobalance.py and tk_punish.py scripts in the standard_admin folder, which means change the __init__.py file to include this script.

The script is very simple, but works well. Later I might add useful bits, like not having to modify the script to approve players or change the player threshold. Also I might change the player threshold to be more dynamic, not counting approved players in the total.

In its current form below, the nicks PLAYER1, PLAYER2 and PLAYER3 will be the only people allowed on the server once 24 players are already present.
<syntaxhighlight code="python">
# Reserved slots system for Battlefield 2
# Martin Ostergaard <monstergod@gmail.com> - 2005

import bf2
import host
from bf2 import g_debug

APPROVED_PLAYERS = ['PLAYER1', 'PLAYER2', 'PLAYER3']
MAX_PLAYERS = 24

def init():
host.registerHandler('PlayerConnect', resPlayerConnect, 1)
host.registerHandler('PlayerDeath', resPlayerDeath, 1)#Added by Milton

def resPlayerConnect(p):
ONLINEPLAYERS = len(bf2.playerManager.getPlayers())

if ONLINEPLAYERS > MAX_PLAYERS:
if APPROVED_PLAYERS.count(p.getName()) < 1:
host.rcon_invoke('admin.kickPlayer ' + str(p.index))
</syntaxhighlight>

# Added by Milton

<syntaxhighlight lang="python">
def resPlayerDeath(p, vehicle):
ONLINEPLAYERS = len(bf2.playerManager.getPlayers())
name = p.getName()
if ONLINEPLAYERS > MAX_PLAYERS:
if APPROVED_PLAYERS.count(p.getName()) < 1:
host.rcon_invoke('PB_SV_Kick ' + name + ' 0 Sorry, making room for members')
return
</syntaxhighlight>

Note from underplay: Im busy right now, but it wouldnt be a bad idea to check to see if the approved players are already in the server..if they are all present, allow players to connect.

Note from monsterdog: Very nice idea, and I have already changed the running version of it substantially, for instance I have added the capability to change the approved list in runtime. I will edit the script on these pages to reflect that once I'm sure it runs smoothly.

Note from bS: I like the idea of this script, one suggestion though. If you just setup one slot as permanently free? ea. you have a 32 player server and make it 33 slots. A player could always connect to the 33rd slot, when this happens an unapproved player would be kicked stating that he connected to a reserved slot; an approved player however will cause the script to kick an unapproved player who is already on the server and thus opening a new reserved slot to repeat the procedure in the future.

Note from Mugzy: How about using a punkbuster kick so the kicked person can see why they were kicked?

Note from Milton: In reply to bS, I modified it a bit so that it does exactly that, when an approved player joins the next person to die that is not approved gets kicked, however the punkbuster kick will not work right as the person joins, unfortunately it seems punkbuster doesn't recognize them untill they get into the server

Note from monsterdog: Also the PB kick appearantly lags the server a bit everytime someone is kicked. I am deliberately putting off playing more with this script until patch 1.03 is out, where it is reportedly possible to kick with a specific message popping up over the server browser. I have an updated version of the script, however, which will let you change the approved list while the server is still running:

<syntaxhighlight lang="python">
# Reserved slots system for Battlefield 2
# Martin Ostergaard - 2005

import bf2
import host
import sys
from bf2 import g_debug

CONFIG_FILE = '/home/bf2user/bf2/admin/standard_admin/approved_players.cfg'
MAX_PLAYERS = 20

def init():
print 'initializing reserved slots script'
host.registerHandler('PlayerConnect', resPlayerConnect, 1)
sys.stdout.flush()

def resPlayerConnect(p):
onlineplayers = len(bf2.playerManager.getPlayers())
new_player = p.getName()

print new_player + ' connected, checking for a free slot'

if onlineplayers > MAX_PLAYERS:
print 'unreserved player max reached, checking if ' + new_player + ' is approved'

CONFIG_FD = open(CONFIG_FILE)
APPROVED_PLAYERS = CONFIG_FD.read()
CONFIG_FD.close()

if APPROVED_PLAYERS.count(new_player) > 0:
print new_player + ' approved for login'
else:
print new_player + ' not approved, will be kicked'
host.rcon_invoke('admin.kickPlayer ' + str(p.index))

sys.stdout.flush()
</syntaxhighlight>

The "approved_players.cfg" is simply a text file, with each players nick on a line by itself, like this:
<pre>
PLAYER_1
PLAYER_2
PLAYER_N
</pre>

Make sure you do not add any empty lines or extra stuff in there. I am pretty certain it will still work if you apply Milton's changes to it. Also note that it actually sends some debugging information out, if you have enabled some kind of error outputting.

Note by monsterdog: OK the above was a bit redundant, saw the new reserved slots script posted on this site, which basically does almost everything I had planned to do, very nice, use that instead :-)

Category:Maintenance

2018-07-02T19:24:55Z

Pireax:

Content related to the maintenance of the bf2tech wiki.

Category:Maintenance

2018-07-02T19:24:33Z

Pireax: Created page with "Content related to the maintenance of the bf2tech wiki. Category:BF2Tech website"

Content related to the maintenance of the bf2tech wiki.
[[Category:BF2Tech website]]

Category:Pages with syntax highlighting errors

2018-07-02T19:20:07Z

Pireax: Created page with "[https://www.mediawiki.org/wiki/Extension:SyntaxHighlight Extension:SyntaxHighlight] adds pages that have a bad <code>lang</code> attribute in a <code><nowiki><source></nowiki..."

[https://www.mediawiki.org/wiki/Extension:SyntaxHighlight Extension:SyntaxHighlight] adds pages that have a bad <code>lang</code> attribute in a <code><nowiki><source></nowiki></code> or <code><nowiki><syntaxhighlight></nowiki></code> tag to this tracking category.

The most common error that leads to pages being tagged with this category is a <code><nowiki><syntaxhighlight></nowiki></code> or <code><nowiki><source></nowiki></code> tag with no <code>lang</code> attribute at all. These can typically be replaced with <code><nowiki><pre></nowiki></code> or <code>lang="bash"</code> can be added.

The second most common error is the use of <code>lang="sh"</code> or <code>lang="shell"</code> which are unsupported. These can typically be replaced with <code>lang="bash"</code> or <code>lang="shell-session"</code>.

[[Category:Maintenance]]

File Formats

2018-07-02T19:16:44Z

Pireax: /* String */

=== Image Files ===
The majority of the image files within the Battlefield 2 directory structure have the '''PNG''' file extension, however most of these image files are in fact '''DDS''' files with an incorrect file extension. There are a few image files that really are PNG files (mainly within <tt>Battlefield 2\mods\bf2\Objects\</tt>), and can be easily loaded by an image viewer/editor.

The image files in Menu_client.zip are packed into a DDS Texture Atlas file. Basicly, an atlas file combines a lot of small images into one big image to improve reading performance. An index file with coordinates is used to locate the individual images in the Atlas.
The Atlas images and index files are located in Menu_client.zip/Atlas.

=== Basic File Format Data Types ===
==== String ====
<syntaxhighlight lang="c">
struct String {
uint len;
char cstr[len];
};
</syntaxhighlight>

==== Vec2 ====
<pre>
struct Vec2 {
float x;
float y;
}
</pre>

==== Vec3 ====
<pre>
struct Vec3 {
float x;
float y;
float z;
}
</pre>

==== Point ====
<pre>
struct Point {
float x;
float y;
float z;
}
</pre>

==== Mat4 ====
<pre>
struct Mat4 {
float m[4][4];
}
</pre>

==== Axis-Aligned Bounding Box ====
Used for collosion detection.
<pre>
struct AABB {
Point endpoint1;
Point endpoint2;
}
</pre>

=== Mesh File Formats ===
A mesh describes how an object in the world needs to be rendered, all mesh file formats use little endian byte order.

==== Common Mesh Data Types ====
===== Header =====
<pre>
struct Header {
uint u1;
uint version;
uint u2; // not used
uint u3; // not used
uint u5; // not used
char u6; // not used
}
</pre>

===== VertexElement =====
<pre>
struct VertexElement {
ushort flag;
ushort offset;
ushort varType;
ushort usage;
}
</pre>

===== Geometry =====
<pre>
struct Geometry {
uint numGeom; // number of geometric objects in this file
uint numLods[numGeom];
uint numVertexElements;
VertexElement vertexElements[numVertexElements]; // based on D3DXVERTEXELEMENT9
uint vertexFormat;
uint vertexStride;
uint numVertices;
float vertices[numVertices * (vertexStride / vertexFormat);
uint numIndices;
ushort indices[numIndices];
}
</pre>

==== .staticmesh File Format ====
The .staticmesh format is used for meshes without animations, below is a description of the file layout in a C like syntax.
<pre>
struct StaticMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes;
Mat4 nodes[numNodes]; // nodes are the respective origins of the objects?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
Vec3 u4;
Vec3 u5;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .bundledmesh File Format ====
<pre>
struct BundledMesh {
Header header;
Geometry geometry;
uint u6;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numNodes; // not used?
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
uint alphaMode; // opaque = 0, blend = 1, alphatest = 2
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .skinnedmesh File Format ====
<pre>
struct SkinnedMesh {
Header header;
Geometry geometry;
struct Lod {
Vec3 u1;
Vec3 u2;
uint numRigs;
struct Rig {
uint numBones;
struct Bone {
uint id;
Mat4 mat; // inverse bone matrix
} bones[numBones];
} rigs[numRigs];
} lods[sum(geometry.numLods, geometry.numGeom)]; // each geometric object can have multiple lods
struct {
uint numMaterials;
struct Material {
String shaderFile;
String technique;
uint numTextureMaps;
String textureMapFiles[numTextureMaps];
uint verticesStartIndex;
uint indicesStartIndex;
uint numIndices;
uint numVertices;
uint u1;
ushort u2;
ushort u3;
} materials[numMaterials];
} geomMaterials[sum(geometry.numLods, geometry.numGeom)];
}
</pre>

==== .mesh File Format ====
It seems that .mesh files are only used for road data. Note that this file has a different layout.
<pre>
struct RoadCompiled {
uint version; // version number consists of major and minor version, latest is 65540, 65540 >> 16 = 1, 65540 % 65536 = 4 (v1.4)
Vec3 u1;
uint u2;
Vec3 u3;
Vec3 u4;
uint u5;
uint numVertices;
struct {
Vec3 pos;
Vec2 tex0;
Vec2 tex1;
uint alpha;
} vertices[numVertices];
uint numIndices;
ushort indices[numIndices];
uint numUnk;
struct {
uint u1;
uint u2;
uint u3;
Vec3 u4;
} unk[numUnk];
}
</pre>

=== terraindata.raw ===
The terraindata.raw file describes the terrain of a level in BF2.
<pre>
struct TerrainData {
uint version;
Vec3 primaryWorldScale;
Vec3 secondaryWorldScale;
float u1;
float u2;
float u3;
uint patchSize;
bool subdividePatches;
uint numPatches;
uint patchColormapSize;
uint lowDetailmapSize;
char* colorMapbaseName; // the following strings use a newline character ('\n') as terminator instead of the normal null terminated C string
char* detailMapbaseName;
char* lowDetailMapbaseName;
char* lightmapBaseName;
Vec2 farSideTiling;
float farSideTilingHi;
float farSideTilingLow;
float farYOffset;
Vec3 terrainSunColor;
Vec3 terrainSkyColor;
Vec3 terrainWaterColor;
uint numLayers; // This is always 6 for BF2, these are the layers as found in the terrain editor
struct {
char* detailTexturePath;
char planeMap;
Vec2 sideTiling;
float topTiling;
float yOffset;
bool envMap;
} layers[numLayers];
uint u6[32 * 21];
uint u7[6 * 85];
uint numIndices;
ushort indices[numIndices];
bool vertexFormat;
struct QuadPatch { // This describes a rectangular region of the main terrain
uint u1;
uint u2;
uint u3;
uint u4;
Vec3 u5;
uint u6;
struct {
float u1;
float u2;
float u3;
float u4;
uint u5;
uint u6;
} compactVertexData[(patchSize + 1) * (patchSize + 1)];
struct {
int magic;
uint i;
Vec3 zero1; // always 0/0/0, no longer in use?
float zero2; // no longer in use?
uint numChartIndices;
uint numChartIndicesDiv3; // this is equal to numChartIndices / 3
uint four; // always the value 4
uint numSubIndexQuads;
struct SubIndexQuad {
uint u1;
uint u2;
uint u3;
uint u4;
uint u5;
uint u6;
} subIndexQuads[numSubIndexQuads];
ushort chartIndices[numChartIndices];
} detailCharts[]; // this array is terminated like a string, it ends when the magic field of the next detail chart is -1
uint terminator; // this will be -1, see above comment
} patches[numPatches * numPatches];
// here should be the data for the surrounding terrain and maybe some other data, not yet clear.
}
</pre>

=== External Links ===
[http://msdn.microsoft.com/library/default.asp?url=/library/en-us/directx9_c/directx/graphics/reference/DDSFileReference/ddsfileformat.asp Microsoft Developer Network DDS File Reference]

[http://www.libpng.org/pub/png/ PNG File Information]

[http://eliteforce2.filefront.com/file/DDS_Converter;29412 DDS File Convertor]

[http://developer.nvidia.com/object/photoshop_dds_plugins.html Nvidia DDS Plugin for reading and writing DDS files in Adobe Photoshop]

[http://developer.nvidia.com/object/texture_atlas_tools.html Nvidia texture atlas tools reading and creating tool]

BF2 Internals

2018-06-25T13:40:13Z

Pireax:

Template:Tip

2018-06-25T13:38:09Z

Pireax:

[[File:Bulbgraph.png|18px|Note|link=]] '''Note:'''

Template:Tip

2018-06-25T13:37:15Z

Pireax: Created page with "<onlyinclude> link= '''Note:''' </onlyinclude>"

<onlyinclude>
[[File:Bulbgraph.png|18px|Note|link=]] '''Note:'''
</onlyinclude>

File:Bulbgraph.png

2018-06-25T13:31:34Z

Pireax:

Scripts:TK punish announcer

2018-06-22T15:38:55Z

Pireax: Created page with "__TOC__ = Introduction = One of the major frustrations in BF2 is the often observed abuse of the PTK function. Since it is so easily available, many people punish others for..."

__TOC__
= Introduction =

One of the major frustrations in BF2 is the often observed abuse of the PTK function. Since it is so easily available, many people punish others for TKs even when it's their own fault. At [http://www.battlefield.no/ Battlefield.no] we do not accept this behaviour, but it can be very hard for admins to take notice of people doing this. We have therefore made a modification to the tk_punish.py-script which is included with BF2.

= Features =

For each player a running tally of the number of forgives and punishes is kept. Whenever someone punishes a TK, a global announcement is made on the server indicating how many punishes and forgives this person has made. This makes it easy to spot people abusing the PTK-system.

This script is a drop-in replacement for the original tk_punish.py which comes with BF2. It is based on the script from the 1.12 release (build 1.1.2554-356). No functionality of the original script has been removed, so this script should be allowed on ranked servers.

= Getting started =

Copy the script from below and replace your current tk_punish.py which you can find under bf2/admin/standard_admin. Remember to make a backup of the original script first!

= The code =

<pre>
The code

# tk punish system

import bf2
import host
from bf2 import g_debug

TK_PUNISH_TIME = 20
TK_PUNISH_COMMANDID = 100
TK_FORGIVE_COMMANDID = 101

hasPendingTks = {}
updateTimer = None

class TkData:
def __init__(self):
self.punished = 0
self.pending = []
self.lastTKedBy = None
self.givenPunish = 0 # bf.no modification
self.givenForgive = 0 # bf.no modification

def init():
if g_debug: print "initializing tk-punish script"

host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerKilled', onPlayerKilled)
host.registerHandler('ClientCommand', onClientCommand)

# Connect already connected players if reinitializing
for p in bf2.playerManager.getPlayers():
onPlayerConnect(p)

checkEnable()

def checkEnable():
global updateTimer

if not bf2.serverSettings.getTKPunishEnabled():
if updateTimer:
updateTimer.destroy()
updateTimer = None
return False
else:
if not updateTimer:
#if g_debug: print "Started timer"
updateTimer = bf2.Timer(onUpdate, 10, 1)
updateTimer.setRecurring(10)

return True

def onUpdate(data):
if not checkEnable(): return
global hasPendingTks

#if len(hasPendingTks) > 0:
# if g_debug: print "update: Has pending tks!"
#else:
# if g_debug: print "update:No pending tks."

currentTime = host.timer_getWallTime()

newPending = {}
for attacker in hasPendingTks.iterkeys():
newList = []
#if g_debug: print "attacker pending list:", len(attacker.tkData.pending)
for tk in attacker.tkData.pending:
tkDate = tk[0]
tkVictim = tk[1]
#if g_debug: print "check %d %s" % (tkDate, tkVictim.getName())

# if there is a pending TK with time expired
if tkDate + TK_PUNISH_TIME < currentTime:
if bf2.serverSettings.getTKPunishByDefault():
attacker.tkData.punished += 1
checkPunishLimit(attacker)
# bf.no addons:
tkVictim.tkData.givenPunish += 1
result = host.rcon_invoke('game.sayAll "TKPUNISH: %s punishes %s for teamkill (%s has %d punishes and %d forgives)"' % (tkVictim.getName(), attacker.getName(), tkVictim.getName(), tkVictim.tkData.givenPunish, tkVictim.tkData.givenForgive))
# *************
# if g_debug: print "Default punished ", attacker.getName()
else:
# bf.no addons:
tkVictim.tkData.givenForgive += 1
# if g_debug: print "Timeouted pending tk for ", attacker.getName()
# pass

# remove player from global list, if it was the last tk
if len(attacker.tkData.pending) == 1:
pass
else:
newPending[attacker] = 1

else:
newList += [tk]
newPending[attacker] = 1

attacker.tkData.pending = newList

hasPendingTks = newPending

def checkPunishLimit(player):
#if g_debug: print "player %s has %d punishes" % (player.getName(), player.tkData.punished)

if player.tkData.punished >= bf2.serverSettings.getTKNumPunishToKick():
if g_debug: print "%s reached punish limit" % player.getName()
if g_debug: print "Banning player!"
result = host.rcon_invoke("admin.banPlayerKey " + str(player.index) + " Round")

# event actions

def onPlayerConnect(player):
player.tkData = TkData()

def onClientCommand(command, issuer, args):
if not checkEnable(): return

#if g_debug: print "received client command"
if command == TK_PUNISH_COMMANDID:
executePunishAction(issuer, True)
elif command == TK_FORGIVE_COMMANDID:
executePunishAction(issuer, False)

def onPlayerKilled(victim, attacker, weapon, assists, object):

if not checkEnable(): return

if not victim or not attacker or victim == attacker or victim.getTeam() != attacker.getTeam(): return

# verify that TK was really given

# no teamkills from wrecks
if object != None and object.getIsWreck():
return

# no teamkills from artillery
if weapon:
attackerVehicle = bf2.objectManager.getRootParent(weapon)
if attackerVehicle.isPlayerControlObject and attackerVehicle.getIsRemoteControlled():
return

# ok, we have a teamkill
currentTime = host.timer_getWallTime()
attacker.tkData.pending += [(currentTime, victim)]
hasPendingTks[attacker] = 1

victim.tkData.lastTKedBy = attacker # can only punish / forgive the last TK'er

bf2.gameLogic.sendClientCommand(victim.index, 100, (2, victim.index, attacker.index, TK_PUNISH_TIME))

def executePunishAction(victim, punish):
if not checkEnable() or not victim or not victim.isValid(): return
attacker = victim.tkData.lastTKedBy
if attacker == None or not attacker.isValid(): return

global hasPendingTks

if punish:
if g_debug: print "%s tkPunished %s" % (victim.getName(), attacker.getName())
else:
if g_debug: print "%s tkForgive %s" % (victim.getName(), attacker.getName())

currentTime = host.timer_getWallTime()

newList = []
for tk in attacker.tkData.pending:
tkDate = tk[0]
tkVictim = tk[1]

# if the attacker had a pending tk, and time has not run out
if tkVictim == victim and tkDate + TK_PUNISH_TIME > currentTime:
if punish:
attacker.tkData.punished += 1
bf2.gameLogic.sendClientCommand(-1, 100, (0, victim.index, attacker.index)) # 100 = tkpunish event, 0 = punish
if g_debug: print "%s punished %s, now has %d punishes" % (victim.getName(), attacker.getName(), attacker.tkData.punished)
# bf.no addons:
victim.tkData.givenPunish += 1
result = host.rcon_invoke('game.sayAll "TKPUNISH: %s punishes %s for teamkill (%s has %d punishes and %d forgives)"' % (victim.getName(), attacker.getName(), victim.getName(), victim.tkData.givenPunish, victim.tkData.givenForgive))
# *************
else:
bf2.gameLogic.sendClientCommand(-1, 100, (1, victim.index, attacker.index)) # 100 = tkpunish event, 1 = forgive
if g_debug: print "%s forgave %s" % (victim.getName(), attacker.getName())
# bf.no addons:
victim.tkData.givenForgive += 1
else:
newList += [tk]

attacker.tkData.pending = newList

if len(attacker.tkData.pending) == 0:
del hasPendingTks[attacker]

checkPunishLimit(attacker)
</pre>

Scripts:ModifiedDemoRotator

2018-06-22T15:38:39Z

Pireax: Created page with "__TOC__ == What It Does == * Checks to see if your demo path and demo target path are the same before moving. This is mainly only useful if you don't want your demos moved,..."

__TOC__
== What It Does ==

* Checks to see if your demo path and demo target path are the same before moving. This is mainly only useful if you don't want your demos moved, but you still want them regularly pruned. (Or if you have your demo path symlinked to your web directory.)
* <code>chmod</code>s all demo files <code>0644</code> so they can be downloaded through the web or in-game.

== Installation ==

# Browser to <code>adminutils/demo/</code> in your bf2 server directory
# Backup <code>rotate_demo.py</code>. (<code>cp rotate_demo.py rotate_demo.py.bak</code>.)
# Download rotate_demo.py.patch or copy the below text into a file manually.
# Patch <code>rotate_demo.py</code>: <code>patch -p0 rotate_demo.py < rotate_demo.py.patch</code>.

== Code ==

=== Downloadable ===

<s>[http://dackz.net/misc/code/rotate_demo/rotate_demo.py.patch http://dackz.net/misc/code/rotate_demo/rotate_demo.py.patch]</s>

=== Readable ===

<pre>
--- rotate_demo.py.orig 2005-06-26 16:02:51.000000000 -0400
+++ rotate_demo.py 2005-06-26 16:06:34.000000000 -0400
@@ -79,13 +79,14 @@
ensure_exists(os.path.join(options['target_root'], 'demos'))

- # try to move the fail, or fail miserably
- try:
- # NOTE: this requires atleast Python 2.3
- print "moving '%s' to '%s'" % (path, target_demo_dir)
- shutil.move(path, target_demo_dir)
- except IOError:
- sys.exit(1)
+ # don't move if path and target are the same
+ if os.path.abspath(os.path.dirname(path)) != os.path.abspath(target_demo_dir):
+ try:
+ # NOTE: this requires atleast Python 2.3
+ print "moving '%s' to '%s'" % (path, target_demo_dir)
+ shutil.move(path, target_demo_dir)
+ except IOError:
+ sys.exit(1)

timestamped = []

@@ -93,6 +94,7 @@
for pf in filter(lambda x: x.endswith('.bf2demo'), os.listdir(target_demo_dir)):
try:
ppath = os.path.join(target_demo_dir, pf)
+ os.chmod(ppath, 0644) # make web-readable
timestamped.append((os.stat(ppath).st_mtime, ppath))
except IOError:
pass # don't let I/O errors stop us</code>
</pre>

Scripts:ClanmemberBalance

2018-06-22T15:38:25Z

Pireax: Created page with "__TOC__ == Short Description == '''Autobalance unleashed by Nexus2k:''' This Modification prevent Clanmembers/Commanders/Squadleaders and Squad Members from Autobalance and..."

__TOC__
== Short Description ==

'''Autobalance unleashed by Nexus2k:'''

This Modification prevent Clanmembers/Commanders/Squadleaders and Squad Members from Autobalance and additionally switchs Clanmembers to one Team on connect

'''Protect Clanmembers/Commander/Squadleader from Autobalance:'''

Open bf2/admin/standard_admin/autobalance.py with a texteditor Add at Line 7:

<pre>
#Change this to your Clantag
clantag="Net.BS|" </pre>

And add at Line 46, after:

<pre>if not bf2.serverSettings.getAutoBalanceTeam(): return </pre>

this:

<pre>
# Prevent Clanmembers from Autobalancing
name=p.getName()
if name.find(clantag)>-1: return None

# Squadleader/Commander prevent from Change
if p.isCommander(): return None
if p.isSquadLeader(): return None
</pre>
--Nexus2k 05:46, 18 Jul 2005 (MDT)

== Additions ==

'''For more than one Clan Tag:'''

Modifiy the clantag variable: from:

<pre>
#Change this to your Clantag
clantag="Net.BS|"
</pre>

to

<pre>
#Insert here your Clantags
clantags=["Net.BS|","|CSAR|"]
</pre>

and from:

<pre>
# Prevent Clanmembers from Autobalancing
name=p.getName()
if name.find(clantag)>-1: return None
</pre>

to

<pre>
# Prevent Clanmembers from Autobalancing
name=p.getName()
for clantag in clantags:
if name.find(clantag)>-1: return None
</pre>

'''Squadmemberautobalanceprotection:'''

(From ~RIP~Brian on [http://bf1942.lightcubed.com/forum/viewtopic.php?p=14370#14370 http://bf1942.lightcubed.com/forum/viewtopic.php?p=14370#14370]) add after this section :

<pre>
# Prevent Clanmembers from Autobalancing
name=p.getName()

if name.find(clantag)>-1: return None
# Squadleader/Commander prevent from Change
if p.isCommander(): return None if p.isSquadLeader(): return None
</pre>

the following code

<pre>
# Prevent squad members from change
if p.getSquadId()>0: return None
</pre>

== More Additions ==

'''Auto TeamSet on Connect:'''

Open autobalance.py add after:

<pre>
if team2 > team1:
p.setTeam(1)
else:
p.setTeam(2)
</pre>

this code part for only One Clan:

<pre>
#change Team to 1 on Connect if Clanmember
name=p.getName()
if name.find(clantag)>-1: p.setTeam(1)
</pre>

or this code part for multiple Clans:

<pre>
#change Team to 1 on Connect if Clanmember
name=p.getName()
for clantag in clantags:
if name.find(clantag)>-1: p.setTeam(1)
</pre>

== Example ==

The whole autobalance.py can look like this:

<pre>
Example

The whole autobalance.py can look like this:

# team autobalance system

import bf2
import host
from bf2 import g_debug

#Insert here your Clantags
clantags=["Net.BS|","|CSAR|"]

def init():
if g_debug: print 'initializing autobalance script'

host.registerHandler('PlayerConnect', onPlayerConnect)
host.registerHandler('PlayerDeath', onPlayerDeath)
host.registerHandler('PlayerChangeTeams', onPlayerChangeTeams)

def onPlayerConnect(p):

# dont teamswitch alive players, or they will have the wrong teams kit
if p.isAlive(): return

# place player on the team with least players
team1 = 0
team2 = 0
for tp in bf2.playerManager.getPlayers():
if tp != p:
if tp.getTeam() == 1: team1 += 1
else: team2 += 1

team2 = team2 * bf2.serverSettings.getTeamRatioPercent() / 100.0
if team2 > team1:
p.setTeam(1)
else:
p.setTeam(2)
#change Team to 1 on Connect if Clanmember
name=p.getName()
for clantag in clantags:
if name.find(clantag)>-1: p.setTeam(1)

def onPlayerDeath(p, vehicle):

if not bf2.serverSettings.getAutoBalanceTeam(): return

# Prevent Clanmembers from Autobalancing
name=p.getName()
for clantag in clantags:
if name.find(clantag)>-1: return None

# Squadleader/Commander prevent from Change
if p.isCommander(): return None
if p.isSquadLeader(): return None

# Prevent squad members from change
if p.getSquadId()>0: return None

# dont use autobalance when its suicide/changes team
if p.getSuicide():
p.setSuicide(0)
return

aiPlayerBalance = 0
team1 = 0
team2 = 0
for tp in bf2.playerManager.getPlayers():
if tp.getTeam() == 1:
team1 += 1
else:
team2 += 1
if tp.isAIPlayer():
aiPlayerBalance += 1
else:
aiPlayerBalance -= 1

if host.sgl_getIsAIGame():
if not (aiPlayerBalance < 0):
if not p.isAIPlayer():
return

team2 = team2 * bf2.serverSettings.getTeamRatioPercent() / 100.0

if (p.getTeam() == 1):
if (team2+1) < team1:
p.setTeam(2)
elif (p.getTeam() == 2):
if (team1+1) < team2:
p.setTeam(1)

def onPlayerChangeTeams(p, humanHasSpawned):

if not bf2.serverSettings.getAutoBalanceTeam(): return

# dont teamswitch alive players, or they will have the wrong teams kit
if p.isAlive(): return

if host.sgl_getIsAIGame():
if humanHasSpawned: return
if p.isAIPlayer(): return

# handling aiplayer team change autobalance when round not started
team = p.getTeam()
aiplayer = 0

for tp in bf2.playerManager.getPlayers():
if aiplayer == 0 and tp.getTeam() == team and tp.isAIPlayer():
aiplayer = tp
break

if aiplayer:
if p.getTeam() == 1: aiplayer.setTeam(2)
else: aiplayer.setTeam(1)

else:
# checking to see if player is allowed to change teams
team1 = 0
team2 = 0
for tp in bf2.playerManager.getPlayers():
if tp.getTeam() == 1: team1 += 1
else: team2 += 1
if abs(team1 - team2) > 1:
if p.getTeam() == 1: p.setTeam(2)
else: p.setTeam(1)
</pre>

== Feautures ==

With all modifications you got a Autobalancescript with following Features:

- Auto set Team 1 for Clanmembers on connect
- Protect Clanmembers from Autobalance
- Protect Commanders and Squadleaders from Autobalance
- Protect Squadmembers from Autobalance

== Feedback ==

You can give me a Feedback at nexus2kswiss(at)bs-dc.com

--Nexus2k 06:02, 21 Jul 2005 (MDT)

Scripts:Modified admin script

2018-06-22T15:38:08Z

Pireax: Created page with "__TOC__ == Introduction == When the BF2 server starts, it loads some code called an '''''admin script'''''. The purpose of the default '''''admin script''''' provided by D..."

__TOC__

== Introduction ==

When the BF2 server starts, it loads some code called an '''''admin script'''''. The purpose of the default '''''admin script''''' provided by Dice, is to create and start an RCON service, letting both connected BF2 clients and standalone RCON clients run RCON commands on the server. The '''''admin script''''' is completely open to the server operator, and can be reprogrammed at will. It is located in the ''admin'' directory of the BF2 server, and the default '''''admin script''''' is called ''default.py''.

We at [http://www.battlefield.no/ Battlefield.no] have created a modified '''''admin script''''' that uses [http://www.multiplay.co.uk/ Steven Hartland's] brilliant idea of making the '''''admin script''''' load a separate configuration file, called ''adminsettings.con'', from the same directory that the server has loaded the map list. These settings are loaded into a Python ''dictionary'' called ''options'', and made globally available via a reference in the 'bf2' object, calles ''adminoptions''. The script also enables logging to both file and UDP, which are both configured using the ''adminsettings.con'' file. The ''adminsettings.con'' file is also re-read on every '''''EndRound''''' server event, so for most settings (RCON port and password being an exception) you do not have to restart the server to see the effect of a changed setting.

== Getting Started ==

No we'll have a look at what you need to do, to get online with the modified '''''admin script'''''. Please note that this description is for doing the modification on Linux. For Windows you will need to make some minor ajustments. Please see the ''discussion'' page for details.

=== Modifying the Admin Script ===

It is not a good idea to modify the original ''default.py''. It is much better to copy it, and start editing the copy. To enable your copy as the '''''admin script''''', simply open the ''serversettings.con'' file that you are using, and edit the server setting called ''sv.adminScript'', like this:

<pre>sv.adminScript = "<name of admin script>" </pre>

We at [http://www.battlefield.no/ Battlefield.no] have called our '''''admin script''''' ''bfno.py'', and hence, our ''serversettings.con'' file is modified to look like this:

<pre>sv.adminScript = "bfno" </pre>

Note the lack of the ''.py'' extension. You will need to change 'bfno' to whatever you call your '''''admin script'''''.

=== Creating the Admin Settings File ===

The ''adminsettings.con'' file needs to reside in the same directory as your current ''maplist''. So if you are starting your BF2 server without the ''+mapList'' option, you must place it in your ''mods/bf2/settings'' directory. When you have created it, you need to populate it with the following settings:

<pre>
admin.rconPort 4711
admin.rconPassword "yourRconPassword"
admin.debugLogEnabled 1
admin.debugLogFile "/path/to/debug.log"
admin.udpLogEnabled 1
admin.udpLogHost "localhost"
admin.udpLogPort 29500
</pre>

You will of course need to change the ports, path and password to your own, and turn off logging to file and/or UDP if you don't want that.

== The Admin Script ==

This is the modified '''''admin script''''' as we use it at [http://www.battlefield.no/ Battlefield.no]. Feel free to copy it, and since this is a wiki, feel free to modify it. But we would be very gratefull of you appended a note in the ''updates'' section if you do.

For your convenience, we've uploaded the script to our website as well. You can download it [http://www.battlefield.no/filer/pafiledb.php?action=file&id=190 here].

=== The Code ===

<pre>
# ------------------------------------------------------------------------
# Battlefield II -- default remote console module.
# ------------------------------------------------------------------------
#
# This is a very simple, TCP based remote console which does simple MD5 digest
# password authentication. It can be configured via the admin/default.cfg file.
# Recognized options are 'port' and 'password'.
#
# Implementation guidelines for this file (and for your own rcon modules):
#
# - All socket operations MUST be non-blocking. If your module blocks on a
# socket the game server will hang.
#
# - Do as little work as possible in update() as it runs in the server main
# loop.
#
# Other notes:
#
# - To get end-of-message markers (0x04 hex) after each reply, begin your
# commands with an ascii 0x02 code. This module will then append the
# end-of-message marker to all results. This is useful if you need to wait
# for a complete response.
#
# Copyright (c)2004 Digital Illusions CE AB
# Author: Andreas `dep' Fredriksson
#
# ------------------------------------------------------------------------
#
# -----------------------------
# Changes made by the community
# -----------------------------
#
# If you make any modifications to this script that enhances its
# functionality, please post the changes to the ICCULUS mailing list.
#
# NB: Use "tab expansion", and expand to 3 spaces!
#
# Maintained by Kybber and Panic, Battlefield.no.
#
# -----------
# Version 1.1
# -----------
#
# The script has been reorganized into the following sections:
# - Import
# - Variables
# - Classes
# - Functions
# - Program
#
# adminsettings.con:
# This version of the admin script uses this file for all admin
# settings. It is read and parsed by 'parseConfig'. The file must
# be located in the same directory as the server is reading the
# maplist from.
#
# class writer:
# A heavily modified copy of the writer class has been added,
# facilitating logging to file and over udp.
#
# def parseConfig:
# The function parseConfig has been updated to load a file called
# adminsettings.con from the same directory as the maplist is being
# read. This emulates the old "+overlaypath" option. Thanks a lot to
# Steven Hartland at Multiplay.co.uk for this!
#
# def onGameStatusChanged:
# This function is built as a callback function to be registered with
# 'host.registerGameStatusHandler(onGameStatusChanged)'. It's intended
# use is to reload the adminsettings.con file.
#
# This version of the file also 'globalizez' the 'options' dictionary,
# by adding a reference called 'adminoptions' to the 'bf2' object.
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# I M P O R T
# ------------------------------------------------------------------------

import socket
import errno
import host
import bf2
import types
import md5
import string
import random
import sys
import datetime

# ------------------------------------------------------------------------
# V A R I A B L E S
# ------------------------------------------------------------------------

# File version
version = "1.1"

# Debug flags:
a_debug = 1 # Get debug info
a_info = 1 # Get other runtime info

# Admin options:
options = {
'admin.rconPort': '4711', # Overwritten by admin.rconPort in adminsettings.con
'admin.rconPassword': None, # Overwritten by admin.rconPassword in adminsettings.con
# True if multiple commands should be processed in one update and
# if as many responses as possible should be sent each update.
'admin.allowBatching': False,
}

# ------------------------------------------------------------------------
# C L A S S E S
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# class writer: Get a hold of stdout and stderr!
# ------------------------------------------------------------------------
class writer:
"""Class for writing output to files and sockets

Arguments
The __init__ function takes no arguments.

Functions
__init__(self) : Creating stream and socket objects to log to.
__del__(self) : Closes the streams and sockets created by __init__.
write(self,str): Write data to the streams and sockets created by __init__.

Description
The intended use of the class is to override sys.stdout and sys.stderr,
like this: sys.stdout = sys.stderr = writer().
"""

# ---------------------------------------------------------------------
# Constructor:
# ---------------------------------------------------------------------
def __init__(self):
"""Creates streams and sockets to log data to, using the write function."""

# Class variables:
self.debugLogEnabled = None
self.debugLogFile = None
self.udpLogEnabled = None
self.udpLogHost = None
self.udpLogPort = None
self.stream = None
self.sock = None

# Try to get the debug log settings:
try:
if str(options['admin.debugLogEnabled']) in ['True','true','1']: self.debugLogEnabled = True
self.debugLogFile = options['admin.debugLogFile']
except:
pass
# Try to get the udp log settings:
try:
if str(options['admin.udpLogEnabled']) in ['True','true','1']: self.udpLogEnabled = True
self.udpLogHost = str(options['admin.udpLogHost'])
self.udpLogPort = int(options['admin.udpLogPort'])
except:
pass

# Prepare for udp logging:
if self.udpLogEnabled and self.udpLogHost and self.udpLogPort:
self.sock = socket.socket(socket.AF_INET,socket.SOCK_DGRAM)

# Prepare for logging to file:
if self.debugLogEnabled and self.debugLogFile:
self.stream = open( self.debugLogFile, 'a+' )

# ---------------------------------------------------------------------

# ---------------------------------------------------------------------
# Deconstructor:
# ---------------------------------------------------------------------
def __del__(self):
"""Closes the streams and sockets created by __init__"""
if self.stream: self.stream.close()
if self.sock: self.sock.close()
# ---------------------------------------------------------------------

# ---------------------------------------------------------------------
# Write data:
# ---------------------------------------------------------------------
"""Writes data to the streams and sockets defined in __init__"""
def write(self, str):
if '\n' != str:
if self.stream: self.stream.write('[' + datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S") + '] ' + str)
if self.sock: self.sock.sendto(str,(self.udpLogHost,self.udpLogPort))
else:
if self.stream:
self.stream.write(str)
self.stream.flush()
# ---------------------------------------------------------------------
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# A stateful output buffer that knows how to enqueue data and ship it out
# without blocking.
# ------------------------------------------------------------------------
class OutputBuffer(object):

def __init__(self, sock):
self.sock = sock
self.data = []
self.index = 0

def enqueue(self, str):
self.data.append(str)

def update(self):
allowBatching = options['admin.allowBatching']
while len(self.data) > 0:
try:
item = self.data[0]
scount = self.sock.send(item[self.index:])
self.index += scount
if self.index == len(item):
del self.data[0]
self.index = 0
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
return detail[1]
if not allowBatching:
break
return None
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Each TCP connection is represented by an object of this class.
# ------------------------------------------------------------------------
class AdminConnection(object):

def __init__(self, srv, sock, addr):
print 'new rcon/admin connection from %s:%d' % (addr[0], addr[1])
self.server = srv
self.sock = sock
self.addr = addr
self.sock.setblocking(0)
self.buffer = ''
self.seed = make_seed(16)
self.correct_digest = digest(self.seed, options['admin.rconPassword'])
self.outbuf = OutputBuffer(self.sock)

# Welcome message *must* end with \n\n
self.outbuf.enqueue('### Battlefield 2 default RCON/admin ready.\n')
self.outbuf.enqueue('### Digest seed: %s\n' % (self.seed))
self.outbuf.enqueue('\n') # terminate welcome message with extra LF

def update(self):
err = None
try:
allowBatching = options['admin.allowBatching']
while not err:
data = self.sock.recv(1024)
if data:
self.buffer += data
while not err:
nlpos = self.buffer.find('\n')
if nlpos != -1:
self.server.onRemoteCommand(self, self.buffer[0:nlpos])
self.buffer = self.buffer[nlpos+1:] # keep rest of buffer
else:
if len(self.buffer) > 128:
err = 'data format error: no newline in message'
break
if not allowBatching: break
else:
err = 'peer disconnected'

if not allowBatching: break

except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
err = detail[1]

if not err:
err = self.outbuf.update()

if err:
print 'rcon: closing %s:%d: %s' % (self.addr[0], self.addr[1], err)
try:
self.sock.shutdown(2)
self.sock.close()
except:
print 'rcon: warning: failed to close %s' % (self.addr)
pass
return 0
else:
return 1
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Context passed to remote command implementations for them to write output to
# either a remote tcp socket or an in-game client executing 'rcon <command>'.
# ------------------------------------------------------------------------
class CommandContext(object):
def __init__(self):
self.player = None
self.socket = None
self.output = []

def isInGame(self): return self.player is not None
def isSocket(self): return self.socket is not None
def write(self, text): self.output.append(text)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# The server itself.
# ------------------------------------------------------------------------
class AdminServer(object):

def __init__(self, port):
# state for tcp rcon connections
self.port = port
self.backlog = 1
self.peers = []
self.openSocket()

# state for in-game rcon connections
host.registerHandler('RemoteCommand', self.onRemoteCommand, 1)
host.registerHandler('PlayerDisconnect', self.onPlayerDisconnect, 1)
host.registerHandler('ChatMessage', self.onChatMessage, 1)

# contains player ids for players which have successfully authenticated
# themselves with 'rcon login <passwd>'
self.authed_players = {}
# contains sockets for connections which have successfully authenticated
# themselves with 'login <passwd>'
self.authed_sockets = {}

# rcon commands supported in this vanilla version
self.rcon_cmds = {
'login': self.rcmd_login,
'users': self.rcmd_users,
'exec': self.rcmd_exec
}

# Called when a user types 'rcon ' followed by any string in a client
# console window or when a TCP client sends a complete line to be
# evaluated.
def onRemoteCommand(self, playerid_or_socket, cmd):
cmd = cmd.strip()
interactive = True

# Is this a non-interactive client?
if len(cmd) > 0 and cmd[0] == '\x02':
cmd = cmd[1:]
interactive = False

spacepos = cmd.find(' ')
if spacepos == -1: spacepos=len(cmd)
subcmd = cmd[0:spacepos]

ctx = CommandContext()
authed = 0
if type(playerid_or_socket) == types.IntType:
ctx.player = playerid_or_socket
authed = self.authed_players.has_key(ctx.player)
else:
ctx.socket = playerid_or_socket
authed = self.authed_sockets.has_key(ctx.socket)

# you can only login unless you are authenticated
if subcmd != 'login' and not authed:
ctx.write('error: not authenticated: you can only invoke \'login\'\n')
else:
if self.rcon_cmds.has_key(subcmd):
self.rcon_cmds[subcmd](ctx, cmd[spacepos+1:])
else:
ctx.write('unknown command: \'%s\'\n' % (subcmd))

feedback = ''.join(ctx.output)
if ctx.socket:
if interactive:
ctx.socket.outbuf.enqueue(feedback)
else:
ctx.socket.outbuf.enqueue(feedback + '\x04')
else:
host.rcon_feedback(ctx.player, feedback)

# When players disconnect, remove them from the auth map if they were
# authenticated so that the next user with the same id doesn't get rcon
# access.
def onPlayerDisconnect(self, player_id):
if self.authed_players.has_key(player_id):
del self.authed_players[player_id]

# Called whenever a player issues a chat string.
def onChatMessage(self, player_id, text, channel, flags):
print 'chat: pid=%d text=\'%s\' channel=%s' % (player_id, text, channel)

# Sets up the listening TCP RCON socket. This binds to 0.0.0.0, which may
# not be what you want but it's a sane default for most installations.
def openSocket(self):
try:
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, 0)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self.sock.bind(('0.0.0.0', self.port))
self.sock.listen(self.backlog)
self.sock.setblocking(0)
except socket.error, detail:
print 'failed to bind rcon socket--only in-game rcon will be enabled'

# WARNING: update is called very frequently -- don't go crazy with logic
# here.
def update(self):
# if we don't have a socket, just return
if not self.sock: return

# without blocking, check for new connections
try:
conn, peeraddr = self.sock.accept()
self.peers.append(AdminConnection(self, conn, peeraddr))
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
raise socket.error, detail

# update clients and mark connections that fail their update
disc = []
for client in self.peers:
if not client.update(): disc.append(client)

# delete any auth status for closed tcp connections
for d in disc:
if self.authed_sockets.has_key(d): del self.authed_sockets[d]

# now keep the remaining clients
self.peers = filter(lambda x: x not in disc, self.peers)

def shutdown(self):
if self.sock:
self.sock.close()

# Command implementations go here (member functions of the AdminServer)

# Allows a in-game rcon client to authenticate and get access.
def rcmd_login(self, ctx, cmd):
success = 0
if ctx.isInGame():
# We're called by an in-game rcon client, use plain-text password
# (encoded into bf2 network stream).
if cmd.strip() == options['admin.rconPassword']:
self.authed_players[ctx.player] = 1
success = 1
elif self.authed_players.has_key(ctx.player):
del self.authed_players[ctx.player]
else:
# tcp client, require seeded digest to match instead of pw
if cmd.strip() == ctx.socket.correct_digest:
self.authed_sockets[ctx.socket] = 1
print 'rcon: tcp client from %s:%d logged on' % ctx.socket.addr
success = 1
else:
if self.authed_sockets.has_key(ctx.socket):
del self.authed_sockets[ctx.socket]
print 'rcon: tcp client from %s:%d failed pw challenge' % ctx.socket.addr

if success:
ctx.write('Authentication successful, rcon ready.\n')
else:
ctx.write('Authentication failed.\n')

# Lists rcon-authenticated players.
def rcmd_users(self, ctx, cmd):
ctx.write('active rcon users:\n')
for id in self.authed_players:
if id == -1:
ctx.write('-1 (local server console)\n')
else:
try:
player = bf2.playerManager.getPlayerByIndex(id)
except:
ctx.write('%d (no info)\n' % (id))

for peer in self.authed_sockets:
ctx.write('tcp: %s:%d\n' % (peer.addr[0], peer.addr[1]))

# Executes a console command on the server.
def rcmd_exec(self, ctx, cmd):
ctx.write(host.rcon_invoke(cmd))
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# F U N C T I O N S
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# These functions are called from the engine
# We implement them in terms of a class instance:
# ------------------------------------------------------------------------
def init():
print 'initializing default admin/rcon module'

# load (optional) admin scripts like teamkill punish and autobalance
import standard_admin

def shutdown():
if server:
print 'shutting down default admin/rcon module'
server.shutdown()

def update():
if server: server.update()
# NB: Use with care!
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Returns a seed string of random characters to be used as a salt
# to protect password sniffing.
# ------------------------------------------------------------------------
def make_seed(seed_length):
return ''.join([string.ascii_letters[random.randint(0, len(string.ascii_letters)-1)] for x in xrange(0, seed_length)])
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Concats a seed string with the password and returns an ASCII-hex MD5 digest.
# ------------------------------------------------------------------------
def digest(seed, pw):
if not pw: return None
m = md5.new()
m.update(seed)
m.update(pw)
return m.hexdigest()
# ------------------------------------------------------------------------

# ---------------------------------------------------------------------
# Convert string to boolean:
# ---------------------------------------------------------------------
def boolFromString(str):
"""Returns a true boolean value based on a boolean string"""
str = str(str)
if str in ['True', 'true', '1']:
return True
elif value in ['False', 'false', '0']:
return False
else:
#raise ValueError # Never mind errors...
return False
# ---------------------------------------------------------------------

# ------------------------------------------------------------------------
# Parses the config file, if it's there
# ------------------------------------------------------------------------
def parseConfig( file ):
"""Function for loading a settings file

Arguments
file: Path to the file to load

Description
This function load a file with key-value-pairs on the form 'key = value',
and updates the dictionary 'options' accordingly.
"""

if a_info: print "ADMIN: Loading '%s'" % ( file )

try:
config = open(file, 'r')
lineNo = 0
for line in config:
lineNo += 1
if line.strip() != '' and line.strip() != '\n':
try:
( key, value ) = line.split( ' ', 1 )
# remove white space
value = value.strip()
# remove outer quotes
value = value.strip( '"' )

if a_info: print "ADMIN: setting '%s' = '%s'" % ( key, value )
if value == 'allowBatching': value = boolFromString (value)
options[key] = value

except ValueError:
if a_debug or a_info: print 'ADMIN: WARNING - syntax error in "%s" on line %d' % (file, lineNo)
except IOError, detail:
if a_debug or a_info: print 'ADMIN: WARNING - couldn\'t read "%s": %s' % (file, detail)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Put stuff you need done by the end of round here
# ------------------------------------------------------------------------
def onGameStatusChanged(status):
"""Handles changes in game status.

Arguments
status: Integer indicating game status. (see bf2.GameStatus.*)

Description
This function is registered with the server with host.registerGameStatusHandler(onGameStatusChanged),
and its intended use is to reload adminsettnigs at the end of rounds, and other, similar tasks.
"""
global adminSettingsFile
if a_debug: print "ADMIN: Entering onGameStatusChanged (" + str(status) +")"
if status == bf2.GameStatus.EndGame:
parseConfig(adminSettingsFile)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# P R O G R A M
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Globalize the admin options:
# ------------------------------------------------------------------------
bf2.adminoptions = options
# Now other scripts might benefit from the settings stored in the
# adminsettings.con file!
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Load admin settings:
# ------------------------------------------------------------------------
# Figure out the "overlay" path:
mapListFileParts = host.rcon_invoke( 'mapList.configFile' ).split( '/' );
del mapListFileParts[len( mapListFileParts ) - 1]
profileDir = "/".join( mapListFileParts )
# Set the full path to our admin settings file:
adminSettingsFile = profileDir + "/adminsettings.con"
# parse the configuration file
parseConfig( adminSettingsFile )
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Register handlers:
# ------------------------------------------------------------------------
# Monitor game status:
host.registerGameStatusHandler(onGameStatusChanged)
# NB: 'onGameStatusChanged' uses the variable 'adminSettingsFile'!
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Enable debug logging:
# ------------------------------------------------------------------------
if a_debug or a_info: sys.stdout = sys.stderr = writer()
print "Logging enabled"
print "Starting rcon on port %s" % ( options['admin.rconPort'] )
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Start the RCON server:
# ------------------------------------------------------------------------
server = AdminServer(int(options['admin.rconPort']))
# ------------------------------------------------------------------------
</pre>

== Updates ==

Please add a note here if you update the code above.

* 2005-06-18: Added documentation (Panic)
* 2005-06-17: Added v1.1 of the code (Panic)

Scripts:Enhanced rotate demo

2018-06-22T15:37:46Z

Pireax: Created page with "__TOC__ == Enhancements == <pre> July 14, 2005 Enhanced rotate_demo.py by: Dave Lawrence thrash@fragnastika.com Includes updates by: dackz </pre> <pre> Changes - Fixed ap..."

__TOC__

== Enhancements ==

<pre>
July 14, 2005
Enhanced rotate_demo.py
by: Dave Lawrence thrash@fragnastika.com
Includes updates by: dackz
</pre>

<pre>
Changes
- Fixed apparent issue where FTP credentials require use of '@' (at least in Win)
- Added grossly verbose error logging for troubleshooting FTP problems
- Added cfg option "verbose_log" to enable verbose logging
- Added verbose log file "rotate_demo_log.txt"
* For console debugging, set verbose_log=0 to log to the console
- Incorporated local file mods by dackz
</pre>

<pre>
Usage:
- In Windows it is recommended to use the compiled version of this tool
- In ServerSettings.con you would use something like the following
- sv.autoDemoHook "adminutils/demo/rotate_demo.exe"
- If you did not receive the exe version of this script, you can compile by:
* Download ActivePython v2.4
* Install ActivePython
* Download py2exe for Python v2.4!
* Install py2exe
* Place the Enhanced rotate_demo.py in AdminUtils\demo
* From the cmd prompt (with python in your PATH), run:
python setup.py py2exe
* py2exe should execute and create a directory: dist
* AdminUtils\demo\dist contains rotate_demo.exe
</pre>

Downloads [http://activestate.com/ http://activestate.com] <s>[http://starship.python.net/crew/theller/py2exe http://starship.python.net/crew/theller/py2exe]</s>

== Installation ==

# Browse to <code>adminutils/demo/</code> in your bf2 server directory
# Backup <code>rotate_demo.py</code>. (<code>cp rotate_demo.py rotate_demo.py.bak</code>.)
# Download rotate_demo.py or copy the below text into a file manually.
# If necessary, download the exe and locate in the same place

== Operation ==

=== General ===

By default, a log file called rotate_demo_log.txt will created that logs the actions from the prior execution. When there is an error, you can view each operation that completed prio to the error as well as the eeor itself in this file. In addition, rotate_demo_err.txt still clumsily records the same info it did before.

If you are having problems getting the demo moved the appropriate place, I strongly recommend that you run the script manualy from the command line, and outside of the game. The script takes one parameter which is the filename of the demo file. This filename can be of any file. IF you want to check the rotation features, just make sure the test files end with ".bf2demo" for example

<pre>
cd /games/bf2
touch test1.bf2demo
python AdminUtils/demo/rotate_demo.py test1.bf2demo
</pre>

It is *much* easier to debug this way.

=== Win BF2 and FTP ===

For some reason I cannot get the rotate_demo.py script to execute properly under a Windows BF2 server using FTP with an FTP username that use a "@". A popular convention on at least cPanel web hosters is to include the server domain name along with the username, separate with "@". For example:

<pre>
Host: files.myhost.com
User: myhoster@myhost.com
Pwd: blahblah
</pre>

With a username as shown above, under Windows, the BF2 server is just not parsing the username correctly and the FTP fails. I have no idea why, although it must have something to do with the BF2 version Python. In any case, if you are using Windows, and you have an FTP username like this, I recommend using the compiled version of this script, rotate_demo.exe. This will work.

== Code ==

=== Downloadable ===

These urls are out of date and no longer available

The source <s>[http://files.fragnastika.net/bf2_rotate_demo/Enhanced/rotate_demo.py http://files.fragnastika.net/bf2_rotate_demo/Enhanced/rotate_demo.py]</s>

The Win exe version <s>[http://files.fragnastika.net/bf2_rotate_demo/Enhanced/rotate_demo.exe http://files.fragnastika.net/bf2_rotate_demo/Enhanced/rotate_demo.exe]</s>

=== Readable ===

<pre>
#! /usr/bin/python
#
# rotate_demo.py: simple file-rotation and index updating script
#
# Requires Python 2.3 or newer.
#
# Theory of operation:
# When automatic demo recording is enabled in the BF2 dedicated server it will
# call a hook program (such as this) when a new demo file is ready for
# publishing. The server will wait for the hook program to complete before
# notifying connected clients of the URL the demo can be downloaded from. It is
# therefore important that all work is done in a blocking manner in this
# program, or clients might try to download demos that aren't in place on the
# web server yet.
#
# Copyright (c)2004 Digital Illusions CE AB
# Author: Andreas Fredriksson

#
# July 14, 2005
# Enhanced rotate_demo.py
# by: Dave Lawrence thrash@fragnastika.com
# Includes updates by: dackz
#
# Changes
# - Fixed apparent issue where FTP credentials require use of '@'
# - Added grossly verbose error logging for troubleshooting FTP problems
# - Added cfg option "verbose_log" to enable verbose logging
# - Added verbose log file "rotate_demo_log.txt"
# * For console debugging, set verbose_log=0 to log to the console
# - Incorporated local file mods by dackz
#
# Usage:
# - In Windows it is recommended to use the compiled version of this tool
# - In ServerSettings.con you would use something like the following
# sv.autoDemoHook "adminutils/demo/rotate_demo.exe"
# - If you did not receive the exe version of this script, you can compile by:
# * Download ActivePython v2.41 from http://activestate.com
# * Install ActivePython
# * Download py2exe from http://starship.python.net/crew/theller/py2exe VERSION 2.4!
# * Install py2exe
# * Place the Enhanced rotate_demo.py in AdminUtils\demo
# * From the cmd prompt (with python in your PATH), run:
# python setup.py py2exe
# * py2exe should execute and create a directory: dist
# * AdminUtils\demo\dist contains rotate_demo.exe
#

import os
import sys
import shutil

# for debugging a hack like this might be useful since stdout and stderr are
# discarded when the script is run
class writer:
def __init__(self):
self.stream = open('rotate_demo_log.txt', 'w')
def write(self, str):
self.stream.write(str)

# helper function to create directories as needed -- this doesn't care about
# umask or permissions in general so consider this a starting point
def ensure_exists(path):
try:
os.stat(path)
except:
try:
os.makedirs(path)
except:
pass

# set some sane defaults
options = {
'use_ftp':'0',
'ftp_server':'',
'ftp_target_dir':'',
'ftp_user':None,
'ftp_password':None,
'target_root': 'webroot',
'file_limit': '10',
'verbose_log': '1',
}

# parse the config file, if it's there
print "Importing cfg\n"
try:
config = open('rotate_demo.cfg', 'rt')
for line_ in config:
line = line_.strip()
if len(line) == 0 or line.startswith('#'): continue
try:
key, value = line.split('=')
options[key.strip()] = value.strip()
except ValueError, ex:
print ex
except IOError:
print "I/O Error on cfg read\n"
pass

if options['verbose_log'] == '1':
sys.stdout = writer()

# our first argument indicates the demo file which is ready to be moved
path = os.path.normpath(sys.argv[1].replace('"', ''))

# handle local file shuffling (web server on same host as bf2 server, or on network share)
if options['use_ftp'] == '0':
print "Using local file shuffle\n"
# this is our target directory (i.e. the download dir)
target_demo_dir = os.path.join(options['target_root'], 'demos')

# create the directory structure if it doesn't exist
ensure_exists(options['target_root'])
ensure_exists(os.path.join(options['target_root'], 'demos'))

if os.path.abspath(os.path.dirname(path)) != os.path.abspath(target_demo_dir):
try:
# NOTE: this requires atleast Python 2.3
print "moving '%s' to '%s'" % (path, target_demo_dir)
shutil.move(path, target_demo_dir)
except IOError:
sys.exit(1)

timestamped = []

# get a list of .bf2demo files in the target dir (including our own file)
for pf in filter(lambda x: x.endswith('.bf2demo'), os.listdir(target_demo_dir)):
try:
ppath = os.path.join(target_demo_dir, pf)
os.chmod(ppath, 0644) # make web-readable
timestamped.append((os.stat(ppath).st_mtime, ppath))
except IOError:
pass # don't let I/O errors stop us

# sort the timestamped file list according to modification time
# NOTE: this sort is reversed so that older files are at the end of the list
def compare_times(f1, f2): return cmp(f2[0], f1[0]) # note reverse sort order
timestamped.sort(compare_times)

# delete the oldest files to meet the file limit
file_limit = int(options['file_limit'])
for timestamp, deletium in timestamped[file_limit:]:
try:
os.remove(deletium)
except IOError:
pass # file in use?

# create the index file
if 0: # dep: I guess this is superfluous
idxf = open(os.path.join(options['target_root'], 'index.lst'), 'w')
for timestamp, keptfile in timestamped[:file_limit]:
fn = keptfile.split(os.sep)[-1]
idxf.write('demos/%s\n' % (fn))
idxf.close()

else: # use ftp
print "Using FTP\n"
try:
import ftplib
import re

path.replace('\\\\', '\\')

path = os.path.normpath(path).replace('\\', '/')

fn = path
idx = fn.rfind('/')
if idx != -1: fn = fn[idx+1:]

try:
os.stat(path)
except:
# This shouldn't happen normally, only when testing from the cmd line
print "ERROR- File does not exist: %s\nAborting\n" % (path)
raise

demof = open(path, 'rb')

# set up ftp connection
print "Connecting to:\n\tHost: %s\n\tUser: %s\n\t Pwd: %s\n" % (options['ftp_server'], options['ftp_user'], options['ftp_password'])
try:
ftp = ftplib.FTP(options['ftp_server'], options['ftp_user'], options['ftp_password'])
except:
print "FTP ERROR: Connect failed!"
raise
print "Connected ... \n"

# change cwd
print "Changing cwd to %s\n" % (options['ftp_target_dir'])
try:
ftp.cwd(options['ftp_target_dir'])
except:
print "FTP ERROR: failed to cwd => %s" % (options['ftp_target_dir'])
raise

file_limit = int(options['file_limit'])

print "Retrieving file listing from FTP ...\n"
try:
files = ftp.nlst()
except Exception:
files = []

files = filter(lambda x: x.endswith('.bf2demo'), files)
files.sort()

for file in files: print "\t" + file

# store the new file
print "\nStoring new demo file: %s" % (fn)
try:
ftp.storbinary('STOR '+fn, demof)
except:
print "FTP ERROR: Upload failed!"

print "\tUpload complete!"
demof.close()

# Remove the local file
print "Removing local demo file %s" % (path)
try:
# delete local file
os.unlink(path)
except OSError:
# couldn't unlink local file, what to do?
print "ERROR- %s Could not be removed!" % (path)
pass

# handle remote rotation
print "\nHandling rotation and removing old FTP demos: file limit = %s" % (file_limit)
while len(files) + 1 > file_limit:
# dep: nb: this relies on the data formatting in the bf2demo filenames
# if you have other
print '\tdeleting %s' % (files[0])
try:
ftp.delete(files[0])
except:
print "FTP ERROR: Unable to delete %s" % (files[0])
pass
del files[0]

# bye bye
ftp.quit()
print "\nConnection closed"

except Exception, detail:
print "\n========================\nROTATE_DEMO ERROR!\n"
import traceback
log = open('rotate_demo_err.txt', 'w')
ex = sys.exc_info()
traceback.print_exception(ex[0], ex[1], ex[2], 16, log)
print "%s\n%s\n%s\n%s\n%s" % (ex[0], ex[1], ex[2], 16, log)
print "========================\n"
log.write('\n')
log.close()
sys.exit(1)
</pre>

Scripts:RestartScript

2018-06-22T15:36:50Z

Pireax: Created page with "__TOC__ = Server Restart Script (Linux Only) = The two scripts underneath are to be used in combination. These have as purpose to re-run the Battlefield 2 Dedicated Server..."

__TOC__
= Server Restart Script (Linux Only) =

The two scripts underneath are to be used in combination. These have as purpose to re-run the Battlefield 2 Dedicated Server when it crashes or quits.

== startit.sh ==

This script initializes the servermonitor script in a screen. If you wish to run multiple server instances you need to change 'screenname' to a different name.

'''NOTE: Make sure to change /path/to/bf2 to your bf2 install dir!!!'''

<code> </code>

<code> </code><pre>
#! /bin/sh

screen -dmS screenname /path/to/bf2/servermonitor
</pre>

== /path/to/bf2/servermonitor ==

This script constantly runs to check wheter the server still runs and restarts it when it doesnt run anymore.

'''NOTE: Make sure to change /path/to/bf2 to your bf2 install dir!!!'''

The only line needed to be changed will be 'exec=/path/to/bf2/start.sh' (line 4)

<code> </code>

<code> </code><pre>
#! /bin/sh

#full path to the start script for the process you want to monitor
exec=/path/to/bf2/start.sh

#interval the script checks to see if the process is still running
interval=10

while :
do
pid=$(ps ax | grep bf2 | grep bin | grep -v grep | awk '{print $1}')
echo $pid
if [ -z "$pid" ]
then
date >> restartlog
echo $procName has stopped!!!! Starting $procName!!!! >> restartlog
echo " "
echo " "

$exec
fi

sleep $interval
done
</pre>

= Made By =

These scripts where delivered to me by David Stevens and according to him they have been build by Rene Belloq.

--Mortis 13:05, 11 Jul 2005 (MDT)

= Addendum =

Just copying the scripts above did not work for me on an actual Linux dedicated server with SuSE 10.2 running.

You should now that i wanted to use them for our BF2 server running the AIX mod on it.

First: I used as screenname "AIXMOD"

<code> </code>

<code> </code><pre>
#! /bin/sh

screen -dmS AIXMOD /path/to/bf2/servermonitor
</pre>

<code></code>

But "servermonitor" did not work, because the command for calling BF2 with the Mod parameter "exec=/path/to/bf2/start.sh +modPath mods/aix" is not known by the bash. Try to use a line calling it the way the shell can handle it instead:

<code> </code>

<code> </code><pre>
#! /bin/sh

#full path to the start script for the process you want to monitor
exec='./start.sh +modPath mods/aix +ignoreAsserts +fileMonitor 1'

#interval the script checks to see if the process is still running
interval=10
</pre>

<code></code>

O.K., finally "servermonitor" started the BF2 server with the AIX mod. But then, the next "problem": After the BF2 server crashed, the "servermonitor" did just a loop, always writing into the "restartlog" that the server is restarting. Again and again, but the server did not come up again. A short "ps x | grep bf2" showed why:

<code> </code>

<code> </code><pre>
11743 ? S 0:00 sshd: bf2server@notty
11804 ? S 0:00 sshd: bf2server@pts/1
11982 ? Ss 0:00 SCREEN -dmS AIXMOD /home/bf2server/bf2/servermonitor
11983 pts/2 Ss+ 0:00 /bin/sh /home/bf2server/bf2/servermonitor
11984 pts/2 Rl+ 4:38 /home/bf2server/bf2/bin/amd-64/bf2 +modPath mods/aix
12328 pts/1 S+ 0:00 grep bf2
</pre>

<code></code>

The script finds way too many pids, if you install your server files e.g. into a directory called "bf2" (as we did). So we checked the default grep command of the script and got 2 pids:

<code> </code>

<code> </code><pre>
bf2server@s15259444:~/bf2> ps x | grep bf2 | grep bin | grep -v grep | awk '{print $1}'
11983
11984
bf2server@s15259444:~/bf2>
</pre>

<code></code>

One of the "servermonitor" itself (pid:11983) and one of the BF2 server running (pid:11984). In order to get just the "interesting" pid we changed the grep command towards:

<code> </code>

<code> </code><pre>
bf2server@s15259444:~/bf2> ps x | grep bf2 | grep bin | grep -v grep | grep -v servermonitor | awk '{print $1}'
11984
bf2server@s15259444:~/bf2>
</pre>

<code></code>

You see ^^, now we get only the pid of the "running" BF2 server, if the BF2 server crashes, that pid will be missing and the restart should work as intended. You should have got the principle how it works, change yours accordingly ;) Hope it helps.

I forgot: You can also change the original grep command "grep bf2" towards a call for the part "amd-64" or "ia-32", depending which you're using on your running AIX server:

<code> </code>

<code> </code><pre>
bf2server@s15259444:~> ps x | grep amd-64 | grep bin | grep -v grep | awk '{print $1}'
11984
bf2server@s15259444:~>
</pre>

<code></code> --BlackBears1 10:36, 16 January 2008 (MST)

= NARS (Not Another Restart Script) =

This Script has been made to be used under a Linux [http://www.rackaid.com/resources/tips/linux-screen.cfm Screen ]

== Script ==

<pre>
#!/bin/bash
#
# Press Ctrl+C to stop the restarting
echo "##########################"
echo "# Bf2 Server Starting #"
echo "##########################"
echo To stop the restarting press Ctrl+C when the server is being restarted
echo
trap 'echo; echo $SRV Server Restarter has been STOPPED!; exit 1' 2
C1=0
while true
do
C1=$((C1+=1))
cd /home/bf2srv/bf2
# Modify the line bellow to match your server execution command line
./start.sh
echo "Bf2 server restarted $C1 time(s)!"
sleep 10
done
</pre>

== Usage ==

First, modify the path to the BF2 server directory on the script. Also you can add some extra variables to the ./start.sh script (like modPath or others). Then save the script as, for example, server_start.sh and store it on the bf2 directory.

Do a:

<pre>chmod +x server_start.sh </pre>

Then, open a new screen (just type screen, then enter), 'inside' the screen, go to the BF2 server directory and type:

<pre>./server_start.sh </pre>

The server will start normally, then detach the screen by pressing 'CTRL + A' and then 'D', the results must be something like:

<pre>[detached] </pre>

Yo can resume the screen and check the server console by doing a:

<pre>screen -r PID </pre>

While PID is the process ID of the screen. If there are no other screen instanses running, you can resume this one using only screen -r

If there is other screens running, the screen -r command will tell you the PIDs of those screens.

=== Notes ===

This script will restart your server if it crashes or quit. Is very simple on the practice, dont be scared.

--DarkPepe 03:32, 14 May 2006 (MDT)

Scripts:Player Position Display

2018-06-22T15:36:26Z

Pireax: Created page with "__TOC__ == Purpose == When run on a testing server this script makes it easy to reposition items around when you're doing server-side mods, as it saves you from opening the B..."

__TOC__
== Purpose ==

When run on a testing server this script makes it easy to reposition items around when you're doing server-side mods, as it saves you from opening the BF2 Editor, or trying to get debug to work to get positions.

This has only ever been used to find positions in a local dedicated server, and will probably cause all kinds of problems if run on a public server, as it probably won't handle map changes/more than 1 player.

The positions have 1.0 subtracted from the y axis (vectors are right/up/forward format), as for the player object it is above ground level. Without this flags, vehicles and spawn points will all be above the ground.

== Installation ==

Requires Modmanager.

Save the following to a file named mm_ppos.py in the [bf2server]/admin/modules/ folder, and add a line to enable it in modmanager.con (usually found in [bf2server]/mods/bf2/settings/).

<pre>
"""Player Position Display module.

===== About =====
This ModManager script displays your current player object's position (less 1.0 in the z axis), and the direction you're facing.

Run it in a solo testing server to find map positions that may be used for server side modding.

Running it on a public populated server will display the positions of all players, and make it difficult to find your own location

===== History =====

v1.0 - 20080503:
Initial public version

By polarity.
Available from bf2tech.org or flightschool.polar-lights.org.uk
You're free to use and modify this script
"""

import bf2
import host
import mm_utils
from bf2.stats.constants import *

# Set the version of your module here
__version__ = 1.0

# Set the required module versions here
__required_modules__ = {
'modmanager': 1.0
}

# Does this module support reload ( are all its reference closed on shutdown? )
__supports_reload__ = True

# Set the description of your module here
__description__ = "PlayerPositionDisplay v%s" % __version__

updateTimer = None

class PlayerPos( object ):

def __init__( self, modManager ):

self.mm = modManager
self.__state = 0

def onPlayerSpawn(self, player, body ):
if 1 != self.__state:
return 0
if (not player.isAIPlayer()):
updateTimer = bf2.Timer( self.onUpdate, 1, 1 )
updateTimer.setRecurring(2)

def StopTimer( self ):
if 1 != self.__state:
return 0
if updateTimer:
updateTimer.destroy()
updateTimer = None

def onUpdate( self, data ):
if 1 != self.__state:
return 0
#mm_utils.msg_server( "timer event called" )
for player in bf2.playerManager.getPlayers():
if not player.isAIPlayer():
vehicle = player.getVehicle()
try:
playerPos = vehicle.getPosition()
playerRot = vehicle.getRotation()
mm_utils.msg_player( player.index, "You are at: %.3f / %.3f / %.3f. Looking %.1f degrees from North." % (playerPos[0], playerPos[1] - 1, playerPos[2], playerRot[0] ) )
#mm_utils.msg_player( player.index, "--------------------------" )
except:
mm_utils.msg_player( player.index, "failed to find soldier object's position" )

def init( self ):
if 0 == self.__state:
host.registerHandler( 'PlayerSpawn', self.onPlayerSpawn, 1 )
# Update to the running state
self.__state = 1
updateTimer = None

def shutdown( self ):
"""Shutdown and stop processing."""

# Unregister game handlers and do any other
# other actions to ensure your module no longer affects
# the game in anyway

#stop the timer
self.StopTimer()
# Flag as shutdown as there is currently way to:
# host.unregisterHandler
self.__state = 2

def update( self ):
"""Process and update.
Note: This is called VERY often processing in here should
be kept to an absolute minimum.
"""
pass

def mm_load( modManager ):
"""Creates and returns your object."""
return PlayerPos( modManager )
</pre>

== Credits ==

The writers of the other scripts found here on bf2tech.org. This uses some of them as a foundation.

Scripts:UDP Based Advert System

2018-06-22T15:36:09Z

Pireax: Created page with "__TOC__ == Introduction == There are many ways to implement an advert system in BF2. A good way would probably be to use the RCON interface. But another one that might be wor..."

__TOC__
== Introduction ==

There are many ways to implement an advert system in BF2. A good way would probably be to use the RCON interface. But another one that might be worth playing around with, is a solution where you create a dedicated ''advert port'' on the server, and send messages to it at will, using a suitable client.

== Server Code ==

The idea is to let the server listen on a port bound to the 'localhost' interface, and read messages off that port, and post them to the players. The socket does of course need to be non-blocking, or it will interfere with the server. But I have no idea if the solution is to use a timer, like this code does. But this at least shows the consept:

<pre>
import socket
import host
import bf2

port = 29600
addr = ('localhost',port)
bufsize = 1024

s = None
msgtimer = None

def init():
global s, msgtimer
print "Initializing the 'advert client' script."
s = socket.socket(socket.AF_INET,socket.SOCK_DGRAM)
s.setblocking(0)
s.bind(addr)
msgtimer = bf2.Timer(read,1,1)
msgtimer.setRecurring(1)

def read(data):
if not s: return
try:
msg, client = s.recvfrom(bufsize)
except:
return False
if msg:
host.rcon_invoke("game.sayAll \"" + str(msg) + "\"")
</pre>

== Client Code ==

The client can be as easy or complex as anyone wish. This is the simplest possible client:

<pre>
#!/usr/bin/env python import socket HOST = 'localhost' PORT = 29600 print "Creating client socket." s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) print "Sending data to server." s.sendto("Hi. I'm an advert client sending data to the server.", (HOST,PORT)) print "Closing socket." s.close()
</pre>

Scripts:ReadingClanmembers

2018-06-22T15:35:54Z

Pireax: Created page with "For some scripts you need to add all your Clanmembers in an array.(for ex. Clan TK Protection) So I made a little Scriptpart which you can use to..."

For some scripts you need to add all your Clanmembers in an array.(for ex. [[Scripts:ClanTkProtection|Clan TK Protection]]) So I made a little Scriptpart which you can use to read all your Clanmembers from a file to an array.

----

paste this code anywhere you would read the Members out of a File:

<pre>
#######################################
# Memberfilereader by Nexus2k #
# #
# Credits to Nexus2kSwiss and Net.BS| #
# BlackSkorpions BF2 Clan #
# www.bs-dc.com #
#######################################
#Open members.cfg in readmode
f=open('members.cfg','r')
#Each line become a Arrayitem in Array "clanmembers"
clanmembers=f.readlines()
#Close File
f.close()
#This deletes the "\n" after each member
clanmembers=[row.replace('\n','') for row in clanmembers]
</pre>

members.cfg:

<pre>
Net.BS|Nexus2kSwiss
Net.BS|BlackSkull
</pre>

Just make a new Line after each Clanmember

--Nexus2k 05:09, 8 Jul 2005 (MDT)

Scripts:PostUrl

2018-06-22T15:35:40Z

Pireax: Created page with "'''posturl''' Usage of postdata(url, data): <code>temp = postdata('[http://www.yourdomain.com/postdata.php%27 http://www.yourdomain.com/postdata.php'], {'field1': 'field1data..."

'''posturl''' Usage of postdata(url, data):

<code>temp = postdata('[http://www.yourdomain.com/postdata.php%27 http://www.yourdomain.com/postdata.php'], {'field1': 'field1data', 'field2': 'field2data'})</code>

<pre>
import string
import socket
import os
import time
import sys
import re
import urlparse

try:
unicode
except NameError:
def _is_unicode(x):
return 0
else:
def _is_unicode(x):
return isinstance(x, unicode)

def toBytes(url):
"""toBytes(u"URL") --> 'URL'."""
# Most URL schemes require ASCII. If that changes, the conversion
# can be relaxed
if _is_unicode(url):
try:
url = url.encode("ASCII")
except UnicodeError:
raise UnicodeError("URL " + repr(url) +
" contains non-ASCII characters")
return url

def unquote(s):
"""unquote('abc%20def') -> 'abc def'."""
mychr = chr
myatoi = int
list = s.split('%')
res = [list[0]]
myappend = res.append
del list[0]
for item in list:
if item[1:2]:
try:
myappend(mychr(myatoi(item[:2], 16))
+ item[2:])
except ValueError:
myappend('%' + item)
else:
myappend('%' + item)
return "".join(res)

def unquote_plus(s):
"""unquote('%7e/abc+def') -> '~/abc def'"""
if '+' in s:
# replace '+' with ' '
s = ' '.join(s.split('+'))
return unquote(s)

always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
'abcdefghijklmnopqrstuvwxyz'
'0123456789' '_.-')

_fast_safe_test = always_safe + '/'
_fast_safe = None

def _fast_quote(s):
global _fast_safe
if _fast_safe is None:
_fast_safe = {}
for c in _fast_safe_test:
_fast_safe[c] = c
res = list(s)
for i in range(len(res)):
c = res[i]
if not c in _fast_safe:
res[i] = '%%%02X' % ord(c)
return ''.join(res)

def quote(s, safe = '/'):
"""quote('abc def') -> 'abc%20def'

Each part of a URL, e.g. the path info, the query, etc., has a
different set of reserved characters that must be quoted.

RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
the following reserved characters.

reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
"$" | ","

Each of these characters is reserved in some component of a URL,
but not necessarily in all of them.

By default, the quote function is intended for quoting the path
section of a URL. Thus, it will not encode '/'. This character
is reserved, but in typical usage the quote function is being
called on a path where the existing slash characters are used as
reserved characters.
"""
safe = always_safe + safe
if _fast_safe_test == safe:
return _fast_quote(s)
res = list(s)
for i in range(len(res)):
c = res[i]
if c not in safe:
res[i] = '%%%02X' % ord(c)
return ''.join(res)

def quote_plus(s, safe = ''):
"""Quote the query fragment of a URL; replacing ' ' with '+'"""
if ' ' in s:
l = s.split(' ')
for i in range(len(l)):
l[i] = quote(l[i], safe)
return '+'.join(l)
else:
return quote(s, safe)

def urlencode(query,doseq=0):
"""Encode a sequence of two-element tuples or dictionary into a URL query string.

If any values in the query arg are sequences and doseq is true, each
sequence element is converted to a separate parameter.

If the query arg is a sequence of two-element tuples, the order of the
parameters in the output will match the order of parameters in the
input.
"""

if hasattr(query,"items"):
# mapping objects
query = query.items()
else:
# it's a bother at times that strings and string-like objects are
# sequences...
try:
# non-sequence items should not work with len()
# non-empty strings will fail this
if len(query) and not isinstance(query[0], tuple):
raise TypeError
# zero-length sequences of all types will get here and succeed,
# but that's a minor nit - since the original implementation
# allowed empty dicts that type of behavior probably should be
# preserved for consistency
except TypeError:
ty,va,tb = sys.exc_info()
raise TypeError, "not a valid non-string sequence or mapping object", tb

l = []
if not doseq:
# preserve old behavior
for k, v in query:
k = quote_plus(str(k))
v = quote_plus(str(v))
l.append(k + '=' + v)
else:
for k, v in query:
k = quote_plus(str(k))
if isinstance(v, str):
v = quote_plus(v)
l.append(k + '=' + v)
elif _is_unicode(v):
# is there a reasonable way to convert to ASCII?
# encode generates a string, but "replace" or "ignore"
# lose information and "strict" can raise UnicodeError
v = quote_plus(v.encode("ASCII","replace"))
l.append(k + '=' + v)
else:
try:
# is this a sufficient test for sequence-ness?
x = len(v)
except TypeError:
# not a sequence
v = quote_plus(str(v))
l.append(k + '=' + v)
else:
# loop over the sequence
for elt in v:
l.append(k + '=' + quote_plus(str(elt)))
return '&'.join(l)

def postdata(url, data):
print 'in postdata function'
urldata = urlparse.urlparse(url)
hostname = urldata[1]
path = urldata[2]
print hostname, path
formdata = bf2.urllib.urlencode(data)
print "formdata", formdata
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((hostname, 80))
s.send("POST %s HTTP/1.0\n" % path)
s.send("Host: %s\n" % hostname)
s.send("Connection: close\n")
s.send("Content-type: application/x-www-form-urlencoded\n")
contentlength = "Content-length: %s\n\n" % len(formdata)
s.send(contentlength)
s.send("%s" % formdata)
splitter = re.compile('\r\n')
while 1:
buf = s.recv(1000)
if not buf:
break
var = splitter.split(buf)

s.close()
return '\r\n'.join(var)
</pre>

Scripts:EventsPy

2018-06-22T15:35:25Z

Pireax: Created page with "__TOC__ == What It Does == * Prints connections, disconnections, and chat messages to the server console. == Installation == # Browse to <code>admin/standard_admin</code>..."

__TOC__
== What It Does ==

* Prints connections, disconnections, and chat messages to the server console.

== Installation ==

# Browse to <code>admin/standard_admin</code> in your bf2 server directory
# Edit <code>__init__.py</code> so it looks something like the code snippet below.
# Save the below code to <code>admin/standard_admin/events.py</code>.
# Run your server. If "<code>events.py loaded</code>" comes up in your server console it should work from there.

== Code ==

=== __init__.py ===

<pre>
import autobalance
import tk_punish
import events

autobalance.init()
tk_punish.init()
events.init()
</pre>

=== events.py ===

<pre>
# script for viewing interesting events in the server console
# -- by dackz (http://dackz.net/)

import bf2
import host
from bf2 import g_debug

def init():
if g_debug: print 'initialising events script'

host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerDisconnect', onPlayerDisconnect, 1)
host.registerHandler('ChatMessage', onChatMessage, 1)

host.rcon_invoke('echo "events.py loaded"')

def onPlayerConnect(player):
host.rcon_invoke('echo "Connected: %s"' % (player.getName()))

def onPlayerDisconnect(player):
host.rcon_invoke('echo "Disconnected: %s"' % (player.getName()))

def onChatMessage(player_id, text, channel, flags):
player = bf2.playerManager.getPlayerByIndex(player_id)

host.rcon_invoke('echo "<%s>%s: %s"' % (channel, player.getName(), text))
</pre>

== Notes ==

The chat text might look a little weird as the script doesn't clean it up at all. You might see things like <code>HUD_TEXT_CHAT_TEAM</code>, <code>*Â§DEADÂ§*</code>, et cetera. Perhaps that will be fixed in the future.

Scripts:EvalPy

2018-06-22T15:35:11Z

Pireax: Created page with "__TOC__ == What It Does == * Allows you to test snippets of Python code while the server is running, without having to restart it to load changes from files. == Installatio..."

__TOC__
== What It Does ==

* Allows you to test snippets of Python code while the server is running, without having to restart it to load changes from files.

== Installation ==

# Browse to <code>admin/standard_admin</code> in your bf2 server directory
# Edit <code>__init__.py</code> so it looks something like the code snippet below.
# Save the below code to <code>admin/standard_admin/eval.py</code>.
# Make sure RCON is configured, then run your server. If "<code>eval.py loaded</code>" comes up in your server console it should work from there.

This doesn't work from the server console. You'll have to use an actual RCON client to use the command this script creates. The <code>remoteconsole.py</code> script should work just fine.

The command is "<code>eval [statement]</code>". An example would be something like the following:

<pre>rcon> eval for i in dir(bf2.objectManager.getObjectsOfTemplate('c4_explosives')[0]): ctx.write(str(i) + '\n')</pre>

Which then might return:

<pre>
__doc__
getChildren
getParent
getPosition
getRotation
getTemplateProperty
hasArmor
isControlPoint
isPlayerControlObject
isValid
setPosition
setRotation
templateName
token
</pre>

'''Note:''' Be extra careful when using <code>ctx.write()</code> over RCON. Though I have the script set to catch all exceptions, giving <code>ctx.write()</code> a non-string will still cause an exception. Failure to take this into account can cause RCON to die completely. Using <code>ctx.write(str(variable))</code> should keep you safe.

== Code ==

=== __init__.py ===

<pre>
import autobalance
import tk_punish
import eval

autobalance.init()
tk_punish.init()
eval.init()
</pre>

=== eval.py ===

<pre>
# script for eval()ing python code over rcon
# -- by dackz (http://dackz.net/)

import sys
import new
import default
import bf2
import host
import game
import standard_admin
from bf2 import g_debug

def write(self, text): self.write_original(str(text))

def rcmd_eval(self, ctx, cmd):
try:
eval(compile(cmd, '<string>', 'exec'))
except:
ctx.write(str(sys.exc_info()[0]).split('.')[-1] + ': ' + str(sys.exc_info()[1]) + '\n')

def init():
if g_debug: print 'initialising eval script'

default.CommandContext.write_original = default.CommandContext.write
newMethod = new.instancemethod(write, None, default.CommandContext)
default.CommandContext.write = newMethod

newMethod = new.instancemethod(rcmd_eval, default.server, default.AdminServer)
default.AdminServer.rcmd_eval = newMethod
default.server.rcon_cmds['eval'] = default.AdminServer.rcmd_eval

host.rcon_invoke('echo "eval.py loaded"')
</pre>

Scripts:ConParser

2018-06-22T15:34:56Z

Pireax: Created page with "__TOC__ == Introduction == This is a very simple parser for the BF2 Con files. You can use it to create BF-Style configs for your python scripts! I haven't tried it in BF2 y..."

__TOC__
== Introduction ==

This is a very simple parser for the BF2 Con files. You can use it to create BF-Style configs for your python scripts! I haven't tried it in BF2 yet, but it should work fine :)

Info: Variables and Expressions are not supported! This is just for reading and saving informations!

== Features ==

* Reads Con files and returns it as a python list
* Writes Con files from a python list to file

== Usage ==

Include the code and include it to your python script - very simple :)

Read files:

<pre>config = readCon('MyConfig.con') </pre>

Write files:

<pre>success = writeCon(config, 'MyConfig.con')</pre>

== The Code ==

<pre>
# ----------------------------------------------
# FIRE'S SIMPLE CON PARSER
#
# CONTACT:
# fire_1@gmx.de
# www.flmod.com
#
# USAGE (READ):
# config = readCon(file)
# Returns a list: [{key1: [values1]}, {key2: [values2, values2]}, ...]
#
# USAGE (WRITE):
# success = writeCon(config, file)
# ----------------------------------------------

# ----------------------------------------------
# Imports
# ----------------------------------------------
import string
from bf2 import g_debug

def readCon(conFile):
config = []
rem = False

# ----------------------------------------------
# Open the file
# ----------------------------------------------
if g_debug:
print 'Reading CON file...'

try:
f = file(conFile, 'r')
lines = f.readlines()
f.close()
except IOError: # Damn..
if g_debug:
print 'Error while reading CON file!!'

return config

for line in lines:
# ----------------------------------------------
# Replace tabs etc.
# ----------------------------------------------
line = string.replace(line, '\t', '\x20')
line = string.strip(line, '\x20\n')

# ----------------------------------------------
# Remove comments
# ----------------------------------------------
if string.strip(string.lower(line[:4])) == 'rem':
continue
elif string.strip(string.lower(line[:9])) == 'beginrem':
rem = True
continue
elif string.strip(string.lower(line[:7])) == 'endrem':
rem = False
continue
else:
if rem:
continue

# ----------------------------------------------
# Find the end of the key
# ----------------------------------------------
pos = string.find(line, '\x20')
if pos < 0: # Not found :(
continue

# ----------------------------------------------
# Get the key
# ----------------------------------------------
key = line[:pos]

# ----------------------------------------------
# Get the values
# ----------------------------------------------
values = string.split(line[pos + 1:], '\x20')
for value in values:
value = string.strip(value, '\x20')

config.append({key: values})

# ----------------------------------------------
# Return the list
# ----------------------------------------------
return config

# --------------------------------------------------------------------------------------------

def writeCon(config, conFile):
# ----------------------------------------------
# Open the file
# ----------------------------------------------
if g_debug:
print 'Writing CON file...'

try:
f = file(conFile, 'w+')
pass
except IOError: # Damn..
return False

data = 'rem *** Created with FiRe\'s CON parser ***\n\n'

# ----------------------------------------------
# Create the Con file
# ----------------------------------------------
for conf in config:
# ----------------------------------------------
# Add the key
# ----------------------------------------------
data += conf.items()[0][0]

# ----------------------------------------------
# Add the values
# ----------------------------------------------
for key in conf.items()[0][1]:
data += ' ' + key
data += '\n'

# ----------------------------------------------
# Write the config to file
# ----------------------------------------------
try:
f.write(data)
f.close()
except IOError:
if g_debug:
print 'Error while writing CON file!!'
return False
else:
return True
</pre>

Scripts:Aircraft Only

2018-06-22T15:34:39Z

Pireax: Created page with "__TOC__ == Purpose == Makes playing outside of an aircraft rather pointless, as you only get 25 seconds before you start to take damage. This was needed as an admin script o..."

__TOC__

== Purpose ==

Makes playing outside of an aircraft rather pointless, as you only get 25 seconds before you start to take damage. This was needed as an admin script on the Coop Flight School server, as there are limited slots, and players on the ground treating it like a normal server were using slots intended for learner pilots.

Could be adapted for use with other vehicles, if for example you wanted to have tank battles or DPV races.

== Installation ==

Requires Modmanager.

Save the following to a file named mm_aironly.py in the [bf2server]/admin/modules/ folder, and add a line to enable it in modmanager.con (usually found in [bf2server]/mods/bf2/settings/).

== The Code ==

<pre>
"""Aircraft Only module.

===== About =====
This ModManager script prevents players from playing as infantry or in ground vehicles,
by causing damage to players who exit the vehicles they're spawned in. Players are given
a warning on exiting, then 25 seconds later they start to receive damage on a 5 second
interval, with further warnings. If they get back into the vehicle then the damage stops.
If they try to get round it by standing near a resupply/crate/medic then the damage rate
will increase to counter the healing.

===== Config =====
Enter the allowed classes in the RequiredTypes list below

===== History =====

v2.1 - 20080507:
v2 bugfix

timers are per player to fix bug from sharing that would punish at wrong time/crash server (no OOP experience before this script)

vehicle parent added to allow gunners/copilots/passengers (still gives warning when switching seats though)

damage switched from 10/2s to 25/5s and delay upped to 20s from 25s

everything reset correctly at round end

===== Credit =====

By polarity, loosely based on vehicle class limit
module by graag42, and other scripts from bf2tech.org

Available from bf2tech.org and flightschool.polar-lights.org.uk
You're free to use and modify this script
"""

import bf2
import host
import mm_utils
from bf2.stats.constants import *

# Set the version of your module here
__version__ = 2.1

# Set the required module versions here
__required_modules__ = {
'modmanager': 1.0
}

# Does this module support reload ( are all its reference closed on shutdown? )
__supports_reload__ = True

# Set the description of your module here
__description__ = "VehicleClassOnly v%s" % __version__

#Required types are safe to be in
RequiredTypes = [VEHICLE_TYPE_HELICOPTER, VEHICLE_TYPE_AVIATOR]

class NoWalk( object ):

def __init__( self, modManager ):

self.mm = modManager
self.__state = 0

def onExitVehicle( self, player, vehicle):
if self.__state == 1:
if ( (not player.isAIPlayer()) & player.isAlive()): #exited vehicle intentionally
if not player.updateTimer:
self.StartTimer( player )

def onEnterVehicle( self, player, vehicle, freeSoldier):
if self.__state == 1:
if (not player.isAIPlayer()):
vehicleType = getVehicleType(vehicle.templateName)
try:
parentVehicle = vehicle.getParent()
parentType = getVehicleType(parentVehicle.templateName)
except:
parentType = 12
if ( vehicleType in RequiredTypes ) | ( parentType in RequiredTypes ):
if player.updateTimer:
self.ResetPlayer( player )
else:
if not player.updateTimer:
self.StartTimer( player )

def onPlayerConnect(self, player ):
if self.__state == 1:
if (not player.isAIPlayer()):
player.updateTimer = None
self.ResetPlayer( player )

def onPlayerSpawn(self, player, body):
if self.__state == 1:
if (not player.isAIPlayer()):
self.ResetPlayer( player )
bf2.Timer(self.PostSpawnTest, 1, 1, player )

def PostSpawnTest(self, player):
if 1 != self.__state:
return 0
if (not player.isAIPlayer()):
vehicle = player.getVehicle()
vehicleType = getVehicleType(vehicle.templateName)
try:
parentVehicle = vehicle.getParent()
parentType = getVehicleType(parentVehicle.templateName)
except:
parentType = 12
if ( vehicleType in RequiredTypes ) | ( parentType in RequiredTypes ):
if player.updateTimer:
self.ResetPlayer( player )
else:
if not player.updateTimer:
self.StartTimer( player )

def onPlayerDeath(self, player, body):
if self.__state == 1:
if (not player.isAIPlayer()):
self.ResetPlayer( player )

def StartTimer( self, player ):
if 1 != self.__state:
return 0
mm_utils.msg_player( player.index, "Fighting on the ground is not permitted in this server." )
mm_utils.msg_player( player.index, "You must enter an aircraft within 25 seconds to avoid punishment." )
player.updateTimer = bf2.Timer(self.onUpdate, 25, 1, player )
player.updateTimer.setRecurring(5)

def StopTimer( self, player ):
if 1 != self.__state:
return 0
if player.updateTimer:
player.updateTimer.destroy()
player.updateTimer = None

def onUpdate( self, player ):
if 1 != self.__state:
return 0
body = player.getDefaultVehicle()
damage = body.getDamage()
if damage > 0: #If you're not dead...
if ((player.lastDamage <= damage) & (player.lastDamage != None) & (player.damageRate < 3000)): #if you've been getting healed
player.damageRate += 25
mm_utils.msg_player( player.index, "You can't avoid punishment by healing. Increasing damage rate." )
elif (player.lastDamage >= damage):
player.damageRate = 25
mm_utils.msg_player( player.index, "Pilots must use aircraft to avoid punishment for being AWOL." )
else:
mm_utils.msg_player( player.index, "Pilots must use aircraft to avoid punishment for being AWOL." )
player.lastDamage = damage
body.setDamage(damage-player.damageRate)
if body.getDamage() < 0:
mm_utils.msg_server( "Pilot %s was killed for going AWOL." % player.getName() )

def ResetPlayer( self, player ):
player.damageRate = 25
player.lastDamage = None
self.StopTimer( player )

def ResetAll( self ):
for player in bf2.playerManager.getPlayers():
if (not player.isAIPlayer()):
self.ResetPlayer( player )

def onGameStatusChanged( self, status ):
# Enables the idle check timer
# Import variables, and update the game status:
global gamestatus
gamestatus = status
if gamestatus == bf2.GameStatus.EndGame:
self.ResetAll()

def init( self ):
if 0 == self.__state:
host.registerHandler( 'ExitVehicle', self.onExitVehicle, 1 )
host.registerHandler( 'EnterVehicle', self.onEnterVehicle, 1 )
host.registerHandler( 'PlayerConnect', self.onPlayerConnect, 1 )
host.registerHandler( 'PlayerSpawn', self.onPlayerSpawn, 1 )
host.registerHandler( 'PlayerDeath', self.onPlayerDeath, 1 )
host.registerGameStatusHandler(self.onGameStatusChanged)

# Update to the running state
self.__state = 1

def shutdown( self ):
"""Shutdown and stop processing."""

# Unregister game handlers and do any other
# other actions to ensure your module no longer affects
# the game in anyway

self.ResetAll()

# Flag as shutdown as there is currently way to:
# host.unregisterHandler
self.__state = 2

def update( self ):
"""Process and update.
Note: This is called VERY often processing in here should
be kept to an absolute minimum.
"""
pass

def mm_load( modManager ):
"""Creates and returns your object."""
return NoWalk( modManager )
</pre>

== Credits ==

Mainly to Graag, as his class limit script was my main reference for this, my first attempt at BF2 python coding.

Scripts:Vehicle Class Limit

2018-06-22T15:34:25Z

Pireax: Created page with "__TOC__ == Introduction == This ModManager script prevents use of certain vehicle classes. Whenever a player enters one of the forbidden vehicles a 10 second timer is start..."

__TOC__
== Introduction ==

This ModManager script prevents use of certain vehicle classes.

Whenever a player enters one of the forbidden vehicles a 10 second timer is started if it's not already running.

When the timer is activated it checks all the players and tries to punish the trespassers. As it's almost impossible to kill a player serverside (the player could be standing near a supply drop, health pack, heli landing pack etc.) the script decreases the health of player and the occupied vehicle, hoping for a fast explosion.

The timer is deactivated if no players were in the forbidden vehicles.

== Prerequisites ==

[[ModManager|ModManager]] or [http://www.bf2cc.com/ BF2CC]

== Install ==

* unzip the file (or copy and paste into ''mm_climit.py'') to ''admin/modules'' in your Battlefield 2 server install.
* if necessary, edit the file and change the forbidden classes (by default the forbidden classes are Armor, Helicopter and Aircraft)
* change your ''modmanager.con'' and include the following line:

<pre>
''modmanager.loadModule "mm_climit"''
</pre>

== Code ==

=== Download ===

The source is included below and the current version is also available [http://www.slo-gamers.com/upload/mm_climit.zip here].

=== Readable ===

<pre>
# vim: ts=4 sw=4 noexpandtab
"""Vehicle class limit module.

===== About =====
This ModManager script prevents use of certain vehicle classes.
Whenever a player enters one of the forbidden vehicles a 10 second timer is started if
it's not already running.
When the timer is activated it checks all the players and tries to punish the trespassers.
As it's almost impossible to kill a player serverside (the player could be standing near
a supply drop, health pack, heli landing pack etc.) the script decreases the health of
player and the occupied vehicle, hoping for a fast explosion. ;)
The timer is deactivated if no players were in the forbidden vehicles.

===== Config =====
Enter the forbidden classes in the ForbiddenTypes list below

===== History =====

v1.0 - 20060119:
Initial public version
v0.9 - 20051224:
Internal release

Author: graag42atgmaildotcom
You're free to use and modify this script
"""

import bf2
import host
import mm_utils
from bf2.stats.constants import *

# Set the version of your module here
__version__ = 1.0

# Set the required module versions here
__required_modules__ = {
'modmanager': 1.0
}

# Does this module support reload ( are all its reference closed on shutdown? )
__supports_reload__ = True

# Set the description of your module here
__description__ = "VehicleClassLimit v%s" % __version__

#comma separated list of forbidden classes ( defined in bf2.stats.constants )
ForbiddenTypes = [VEHICLE_TYPE_ARMOR, VEHICLE_TYPE_AVIATOR, VEHICLE_TYPE_HELICOPTER]

updateTimer = None

class NoFly( object ):

def __init__( self, modManager ):
# ModManager reference
self.mm = modManager

# Internal shutdown state
self.__state = 0

# Add any static initialisation here.
# Note: Handler registration should not be done here
# but instead in the init() method

def onEnterVehicle( self, player, vehicle, freeSoldier):
"""Player entered a vehicle - check if the class is allowed and start the timer in not."""
if 1 != self.__state:
return 0

# Put your actions here
if self.checkPlayerVehicle( player, vehicle, 0 ):
self.StartTimer()

def StartTimer( self ):
"""Start the timer if the state allows it and the timer isn't already started"""
if 1 != self.__state:
return 0
if not self.updateTimer:
#self.mm.info( "Starting timer" )
#mm_utils.msg_server( "Starting timer" )
self.updateTimer = bf2.Timer(self.onUpdate, 10, 1)
self.updateTimer.setRecurring(10)
else:
#self.mm.info( "Timer already enabled" )
#mm_utils.msg_server( "Timer already enabled" )
pass

def StopTimer( self ):
"""Shutdown the timer"""
if self.updateTimer:
#self.mm.info( "Stopping timer" )
#mm_utils.msg_server( "Stopping timer" )
self.updateTimer.destroy()
self.updateTimer = None
else:
#self.mm.info( "Timer already stopped" )
#mm_utils.msg_server( "Timer already stopped" )
pass

def checkPlayerVehicle( self, player, vehicle, mode ):
"""mode 0 - player just entered vehicle, 1 - timed check
if the vehicle class is forbidden:
mode 0 - notify player via server message
mode 1 - punish player
returns True if player is in forbidden vehicle class, False othervise"""

forbiddenClass = False
try:
vehicleType = getVehicleType(vehicle.templateName)
vehicleDamage = vehicle.getDamage()
body=player.getDefaultVehicle()
bodyHealth=body.getDamage()

#debug
#if 1 == mode:
# self.mm.info( "Player %s (health %d) is in %s (class %d, health %d)" % ( player.getName(), bodyHealth, vehicle.templateName, vehicleType, vehicleDamage ) )
# #mm_utils.msg_server( "Player %s (health %d) is in %s (class %d, health %d)" % ( player.getName(), bodyHealth, vehicle.templateName, vehicleType, vehicleDamage ) )
#else:
# self.mm.info( "Player %s (health %d) entered %s (class %d, health %d)" % ( player.getName(), bodyHealth, vehicle.templateName, vehicleType, vehicleDamage ) )
# #mm_utils.msg_server( "Player %s (health %d) entered %s (class %d, health %d)" % ( player.getName(), bodyHealth, vehicle.templateName, vehicleType, vehicleDamage ) )

if vehicleType in ForbiddenTypes:
forbiddenClass = True
if 1 == mode:
#punish
mm_utils.msg_server( "Oh noes %s!" % ( player.getName() ) )
vehicle.setDamage(0.01)
body.setDamage(0.01)
else:
#notify
mm_utils.msg_server( "%s entered %s. Somebody set up us the bomb. Get out, QUICK!" % ( player.getName(), vehicle.templateName ) )
except:
forbiddenClass = False

return forbiddenClass

def init( self ):
"""Provides default initialisation."""

# Register your game handlers and provide any
# other dynamic initialisation here
self.updateTimer = None

if 0 == self.__state:
# Register your host handlers here
host.registerHandler( 'EnterVehicle', self.onEnterVehicle, 1 )

# Update to the running state
self.__state = 1

# start the timer: if the module was reset during the game at least one check will be made
# if no players are in forbidden vehicles the timer will shut down until someone enters one
self.StartTimer()

def onUpdate( self, data ):
"""timed check of all players"""
if 1 != self.__state:
return

needTimer = False
for player in bf2.playerManager.getPlayers():
try:
vehicle=player.getVehicle();
if self.checkPlayerVehicle(player, vehicle, 1): needTimer = True
except:
try:
player_name = player.getName()
except:
player_name = 'unknown'
self.mm.error( "Failed to check player '%s'" % player_name, True )

#do we still need the timer (at least 1 player in a forbidden class vehicle)?
if needTimer:
self.StartTimer()
else:
self.StopTimer()

def shutdown( self ):
"""Shutdown and stop processing."""

# Unregister game handlers and do any other
# other actions to ensure your module no longer affects
# the game in anyway

#stop the timer
self.StopTimer
# Flag as shutdown as there is currently way to:
# host.unregisterHandler
self.__state = 2

def update( self ):
"""Process and update.
Note: This is called VERY often processing in here should
be kept to an absolute minimum.
"""
pass

def mm_load( modManager ):
"""Creates and returns your object."""
return NoFly( modManager )
</pre>

Scripts:BF2Oldschool

2018-06-22T15:34:09Z

Pireax: Created page with "__TOC__ == Introduction == Today infantry game is strictly connected to official rules that are in ClanBase or ESL. Many of ranked or waib servers put in thier rules: no unl..."

__TOC__
== Introduction ==

Today infantry game is strictly connected to official rules that are in ClanBase or ESL. Many of ranked or waib servers put in thier rules: no unlocks, no commanders, co c4 etc. But as always only human administrator can prevent people from n00bs that are using forbidden candys. So i created this script to do this automaticly!

== Features ==

'''''Battlefield 2 Oldschool Infantry Script''''' can offer:

* Detect weapons on server, based on four diffrent levels '''NO MEDICS(with unlocks), NO MEDICS(without unlocks), KNIFE-PISTOL-SHOCKPADDLE ONLY, NO UNLOCKS '''

** Also detect misc weapons like: '''C4, CLAYMORE, Mounted MGS (stationary) and TOW Missle'''

* Restriction with three modes:

** Only inform player that his weapon is forbidden
** Kill player just after respawn with forbidden weapon
** Kick player after specified number of frags with forbidden weapon

* Detect commander

** Only info about new commander
** Kick commander

* Almoust all settings of this script can be modified on the fly via custom rcon command (it works in game console!)

== Install ==

* Go to mods/bf2/python/game/ direcory located on your server (ex. BF2_v1.1.2965/mods/bf2/python/game/)
* Paste there bf2_oldschool.py file
* Edit __init__.py file and add this two lines:

<pre>
import bf2_oldschool
bf2_oldschool.init()
</pre>

* Restart/run your server

== Configuration ==

Look inside bf2_oldschool.py file.
There is all what you need to configure and use this script.

== Code ==

=== Download ===

Follow this link to download always the latest version
Primary download: [http://vis-clan.pl/index.php?file=Download&op=description&dl_id=5 here]

=== Readable ===
<pre>
##############################################################################
# #
# bf2_oldschool.py - Weapon Punisher by MisiekBest #
# --- http://vis-clan.pl --- #
# --- http://bfo.misiekbest.pl --- #
# #
# Released: 28.12.2009 #
# Script Version: 0.9c #
# Copyright (C) 2009-2010 Michal 'MisiekBest' Pawlikowski #
# #
# This program 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 3 of the License, or #
# 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/ . #
# #
##############################################################################
"""
################
# What it is?: #
#########################################################
# BF2 Oldschool is a Battlefield 2 #
# python script made for few things: #
# - Restrict some weapons on server #
# - Kick or kill player for using restricted weapon #
# - Kick commander (or just throw info) #
# - Manage script via rcon #
#########################################################

###################
# How to install: #
##################################################################
# 1. Go to mods/bf2/python/game/ direcory located on your server #
# (ex. BF2_v1.1.2965/mods/bf2/python/game/) #
# 2. Paste there this file #
# 3. Edit __init__.py file and add this two lines: #
# import bf2_oldschool #
# bf2_oldschool.init() #
# 4. Restart/run your server :) #
##################################################################

###################################
# How to manage sctipt via rcon?: #
###############################################################################################
# This script has 'diffrent' manage method. Why diffrent? #
# Usually admins can manage their scripts using in game chat. #
# Yes, its easiest way, but not efficient. So i decided to use #
# little hook with rcon <variable>. It will always generate info #
# about error (in game console) but it will work! #
# #
# First you must remember to put your/admin's nickname in settings. #
# Rcon will work only for players that are in ADMIN_LIST. #
# See ADMIN SETTINGS section for more info. #
# #
# TO RUN COMMAND: #
# #
# 1. Open your in-game console (by pressing ~ on your keyboard) #
# 2. Every command you must execute using phrase: rcon bfo <command> <optional_value> #
# #
# You can access to this help in game by using 'rcon bfo help' command. #
# You can return all main settings by using 'rcon bfo status' command. #
# #
# Here is list of all commands: #
# ############## OLDSCHOOL LEVEL ############## #
# ############################################# #
# olevel # Return number of oldschool level #
# olevel [value] # Set oldschool level to given value #
# #
# ############## PUNISH METHOD ############## #
# ############################################ #
# punish # Return number of punish method #
# punish [value] # Set punish method to given value #
# #
# ############## MISC WEAPONS ############## #
# ############################################## #
# c4 # Return status of C4 restriction #
# c4 [value] # Enable or disble C4 restriction. 0-Disable 1-Enable #
# claymore # Return status of CLAYMORE restriction #
# claymore [value] # Enable or disble CLAYMORE restriction. 0-Disable 1-Enable #
# mgs # Return status of MOUNTED MGS restriction #
# mgs [value] # Enable or disble MOUNTED MGS restriction. 0-Disable 1-Enable #
# tow # Return status of TOW MISSILE restriction #
# tow [value] # Enable or disble TOW MISSILE restriction. 0-Disable 1-Enable #
# #
# ############## KICKER SYSTEM (punish 2) ############## #
# ########################################################## #
# kick_frags # Return number of how many kills from restricted weapon to kick player #
# kick_frags [value] # Set HOW_MANY_KILLS_TO_KICK to given value #
# kick_time # Return minutes for how long player should be kicked out. #
# kick_time [value] # Set minutes for how long player should be kicked out. #
# #
# ############## ANTI COMMANDER ############## #
# ################################################## #
# anticomm # Return status of ANTICOMMANDER system #
# anticomm [value] # Enable or disble commander restriction. 0-Disable 1-Enable #
# commkick # Return status of COMMANDER KICKER system #
# commkick [value] # Enable or disble commander kicking. 0-Disable 1-Enable #
# commkick_time # Return minutes for how long commander should be kicked out. #
# commkick_time [value] # Set minutes for how long commander should be kicked out. #
# #
# #
###############################################################################################

CHANGELOG:

0.9c:
- Added "NO SNIPERS" restriction mode (OLDSCHOOL_LEVEL = 6)
"""

################################################################################
################################################################################
##-> GLOBAL CONFIGURATION <-##
################################################################################
################################################################################

###################
# OLDSCHOOL LEVEL #
#################################################################################################
# Here you can decide which group of weapons should be restricted #
# Set OLDSCHOOL_LEVEL to one of these values: #
# 0 - Completly disable script! #
# 1 - MEDICS ONLY (with med unlocks!) #
# 2 - MEDICS ONLY (without med unlocks!) #
# 3 - KNIFE, PISTOL, SHOCKPADDLE (only these weapons are allowed! Other will be punished. #
# (NOTE: OLDSCHOOL LEVEL 3 WILL WORK ONLY WITH PUNISH METHOD 2 (kicking)!!!) #
# 4 - NO UNLOCKS (all kits but without unlocks) #
# 5 - NO OLDSCHOOL LEVEL, JUST USE OTHER SETTINGS (in.ex.: anticommander or c4, claymore etc.) #
# 6 - NO SNIPERS #
#################################################################################################
OLDSCHOOL_LEVEL = 6

###################
# MISC WEAPONS #
#####################################################################
# Here you can enable or disable punishing for using #
# miscellaneous wapons: c4, claymore, stationary mgs and tow missle #
# Set each variable to 0 or 1 #
# 0 - DISABLE #
# 1 - ENABLE #
#####################################################################
NO_C4 = 0
NO_CLAYMORE = 1
NO_MOUNTED_MGS = 0 #NOTE: WORKS ONLY WITH PUNISH METHOD 2
NO_TOW_MISSILE = 0 #NOTE: WORKS ONLY WITH PUNISH METHOD 2

####################
# PUNISH METHOD #
####################################################################################################################
# Here you can choose how player should be punished for using restricted weapon. #
# Set PUNISH_METHOD to one of these values: #
# 0 - NO PUNISH, ONLY WARNING. Warning can be set in WARNING_LVL0 (put %s for player name) #
# NOTE: this will produce massive spam if player #
# will start switching weapons for example from allowed pistol to forbidden #
# g36e, then pistol and then again g36e etc. #
# #
# 1 - KILL PLAYER JUST AFTER RESPAWN WITH FORBIDDEN WEAPON. #
# Killing msg can be set in WARNING_LVL1 (put %s for player name) #
# NOTE: if c4 or clay is forbidden player will be punished after #
# switching to them by pressing 5 or 6 key #
# #
# 2 - KICK PLAYER AFTER HOW_MANY_KILLS_TO_KICK TIMES #
# (PUNKBUSTER PROTECTION MUST BE ENABLED!) #
# Here you can also set few things: #
# HOW_MANY_KILLS_TO_KICK - After how many frags player should be kicked out? #
# #
# WARNING_AFTER_FRAG - This message will appear when player kill somebody with forbidden weapon #
# (put %s for player name) #
# #
# RESTRICTED_WEAPON_KICK_MSG - This msg appears in game when script is kicking player (put %s for player name) #
# #
# RESTRICTED_WEAPON_KICK_REASON - This msg gets player after kick - in cool punkbuster window :) #
# #
# RESTRICTED_WEAPON_KICK_IN_MINUTES - Here you can decide for how long player should be kicked. Use wisely ;) #
####################################################################################################################
PUNISH_METHOD = 2

#######################################
# PUNISH METHOD 0 - CONFIG #
#######################################
WARNING_LVL0 = "Warning %s ! Do not use this weapon! Its forbidden!"

#######################################
# PUNISH METHOD 1 - CONFIG #
#######################################
WARNING_LVL1 = "Warning %s ! You have been killed for using restricted weapon!"

#######################################
# PUNISH METHOD 2 - CONFIG #
#######################################
HOW_MANY_KILLS_TO_KICK = 2
WARNING_AFTER_FRAG = "Warning %s ! This weapon is forbidden! Stop being a n00b or you will get kicked!"
RESTRICTED_WEAPON_KICK_MSG = "Kicking %s for using restricted weapons!"
RESTRICTED_WEAPON_KICK_REASON = "You have been kicked for using restricted weapons!"
RESTRICTED_WEAPON_KICK_IN_MINUTES = 10

#####################
# ANTI COMMANDER #
#############################################################################################################
# Here you can enable or disable commander protection. #
# Module can be enabled with ANTICOMMANDER set to 1. Use 0 to disable it. #
# Warning can be set in COMMANDER_MSG (put %s for player name) #
# #
# Instead of 'only info' you can enable commander kicking by switching COMMANDER_AUTOKICK to 1 #
# Then you can set other things: #
# #
# COMMANDER_KICK_TIME_IN_MINUTES - For how long commander should be kicked out? #
# #
# COMMANDER_KICK_MSG - This msg appears in game when script is kicking commander (put %s for player name) #
# #
# COMMANDER_KICK_REASON - This msg gets player after kick - of course in cool punkbuster window ;) #
#############################################################################################################
ANTICOMMANDER = 0
COMMANDER_MSG = "Warning! Player %s became a commander!"

COMMANDER_AUTOKICK = 0
COMMANDER_KICK_TIME_IN_MINUTES = 2
COMMANDER_KICK_MSG = "Kicking %s for using commander!"
COMMANDER_KICK_REASON = "You have been kicked for using commander!"

######################
# ADMIN SETTINGS #
###########################################################################################
# Here you can set new admin(s) for rcon administration of this script. #
# Just put his/her name in " " (dont forget about prefix!). Add comma if more then one ;] #
# example: ADMIN_LIST = "[V!S] MisiekBest[PL]", "#SOF# FrYzJeR.inf" #
###########################################################################################
ADMIN_LIST = "[V!S] MisiekBest[PL]", "#NM# MisiekBest[PL]"

################################################################################
################################################################################
##-> END OF GLOBAL CONFIGURATION <-##
##-> DONT CHANGE ANYTHING BELOW ;) <-##
################################################################################
################################################################################

import bf2
import host
_MED_ONLY_FW_ = "usrif_m4","usrif_m24","usrif_m203","uslmg_m249saw","usrif_remington11-87","usrif_mp5_a3","usrgl_m203","usatp_predator","c4_explosives","usmin_claymore","at_mine","rurrif_ak74u","rurif_dragunov","rurif_gp30","rulmg_rpk74","rusht_saiga12","rurif_bizon","rurgl_gp30","chat_eryx","chrif_type95","chsni_type88","rurif_gp25","chlmg_type95","chsht_norinco982","chrif_type85","rurgl_gp25","usrif_g36c","ussni_m95_barret","usrif_g3a3","rulmg_pkm","ussht_jackhammer","chsht_protecta","usrif_fnscarl","gbrif_l96a1","sasrif_fn2000","sasgr_fn2000","sasrif_mg36","sasrif_mp7","eurif_fnp90"
_MED_ONLY_NO_UN_FW_ = "usrif_m4","usrif_m24","usrif_m203","uslmg_m249saw","usrif_remington11-87","usrif_mp5_a3","usrgl_m203","usatp_predator","c4_explosives","usmin_claymore","at_mine","rurrif_ak74u","rurif_dragunov","rurif_gp30","rulmg_rpk74","rusht_saiga12","rurif_bizon","rurgl_gp30","chat_eryx","chrif_type95","chsni_type88","rurif_gp25","chlmg_type95","chsht_norinco982","chrif_type85","rurgl_gp25","usrif_g36c","ussni_m95_barret","usrif_g3a3","rulmg_pkm","ussht_jackhammer","chsht_protecta","usrif_fnscarl","gbrif_l96a1","sasrif_fn2000","sasgr_fn2000","sasrif_mg36","sasrif_mp7","eurif_fnp90","usrif_sa80","sasrif_g36e"
_KPS_ONLY_AW_ = "kni_knife","uspis_92fs_silencer","uspis_92fs","rupis_baghira_silencer","rupis_baghira","chpis_qsz92_silencer","chpis_qsz92"
_NO_UNLOCKS_FW_ = "usrif_g36c","ussni_m95_barret","usrif_g3a3","rulmg_pkm","ussht_jackhammer","usrif_sa80","chsht_protecta","usrif_fnscarl","gbrif_l96a1","sasrif_fn2000","sasgr_fn2000","sasrif_mg36","sasrif_mp7","sasrif_g36e","eurif_fnp90"
_NO_SNIPERS_ = "usrif_m24","rurif_dragunov","chsni_type88", "ussni_m95_barret", "gbrif_l96a1"
playerKickList = []
def init():
global OLDSCHOOL_LEVEL, PUNISH_METHOD, ANTICOMMANDER
if (OLDSCHOOL_LEVEL != 0):
if (ANTICOMMANDER == 1): host.registerHandler('ChangedCommander', onCommander, 1)
if (PUNISH_METHOD == 2): host.registerHandler('PlayerKilled', onPlayerKilled, 1)
if (PUNISH_METHOD == 0 or (PUNISH_METHOD == 1 and OLDSCHOOL_LEVEL != 3)): host.registerHandler('PlayerChangeWeapon', onPlayerChangeWeapon, 1)
host.registerHandler('RemoteCommand', onRemoteCommand, 1)
host.registerGameStatusHandler(onGameStatusChange)
host.rcon_invoke('echo "bf2_oldschool.py by MisiekBest loaded"')
else:
host.rcon_invoke('echo "bf2_oldschool.py by MisiekBest loaded, script DISABLED by config!"')

def onCommander(teamid, oldCommanderPlayerObject, player):
global OLDSCHOOL_LEVEL
if (OLDSCHOOL_LEVEL != 0):
global ANTICOMMANDER
if (ANTICOMMANDER): #yeap. Double check. Unfortunately DICE forgot to implement host.UNregisterHandler... And this is the only way to disable anticommander (and other) 'on the fly' by using remote rcon command. Sorry :P
global COMMANDER_AUTOKICK
if (COMMANDER_AUTOKICK == 1):
global COMMANDER_KICK_MSG, COMMANDER_KICK_REASON, COMMANDER_KICK_TIME_IN_MINUTES
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_KICK_MSG) % (player.getName()), 0)
host.rcon_invoke("pb_sv_kick \""+str(player.getName())+"\" "+str(COMMANDER_KICK_TIME_IN_MINUTES)+" \""+str(COMMANDER_KICK_REASON)+"\"")
else:
global COMMANDER_MSG
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_MSG) % (player.getName()), 0)
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_MSG) % (player.getName()), 0)
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_MSG) % (player.getName()), 0)
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_MSG) % (player.getName()), 0)
host.sgl_sendTextMessage( 0, 12, 1, str(COMMANDER_MSG) % (player.getName()), 0)

def onPlayerKilled(victim, attacker, weapon, assists, victimSoldierObject):
global OLDSCHOOL_LEVEL
if (OLDSCHOOL_LEVEL != 0):
global PUNISH_METHOD
if (PUNISH_METHOD == 2):
global NO_C4, NO_CLAYMORE, NO_MOUNTED_MGS, NO_TOW_MISSILE
if OLDSCHOOL_LEVEL == 1:
global _MED_ONLY_FW_
checkAndJudge(_MED_ONLY_FW_,attacker,weapon,0)
elif OLDSCHOOL_LEVEL == 2:
global _MED_ONLY_NO_UN_FW_
checkAndJudge(_MED_ONLY_NO_UN_FW_,attacker,weapon,0)
elif OLDSCHOOL_LEVEL == 3:
global _KPS_ONLY_AW_
checkAndJudge(_KPS_ONLY_AW_,attacker,weapon,1)
elif OLDSCHOOL_LEVEL == 4:
global _NO_UNLOCKS_FW_
checkAndJudge(_NO_UNLOCKS_FW_,attacker,weapon,0)
elif OLDSCHOOL_LEVEL == 5:
pass
elif OLDSCHOOL_LEVEL == 6:
global _NO_SNIPERS_
checkAndJudge(_NO_SNIPERS_,attacker,weapon,0)
else:
pass

if NO_C4 or NO_CLAYMORE or NO_MOUNTED_MGS or NO_TOW_MISSILE: checkAndJudgeMisc(attacker, weapon)

def onPlayerChangeWeapon(player, oldWeapon, weapon):
global OLDSCHOOL_LEVEL, PUNISH_METHOD
if (OLDSCHOOL_LEVEL != 0):
if (PUNISH_METHOD == 0 or (PUNISH_METHOD == 1 and OLDSCHOOL_LEVEL != 3)):
global NO_C4, NO_CLAYMORE, NO_MOUNTED_MGS, NO_TOW_MISSILE
if OLDSCHOOL_LEVEL == 1:
global _MED_ONLY_FW_
changedWeapon(_MED_ONLY_FW_,player,weapon,0)
elif OLDSCHOOL_LEVEL == 2:
global _MED_ONLY_NO_UN_FW_
changedWeapon(_MED_ONLY_NO_UN_FW_,player,weapon,0)
elif OLDSCHOOL_LEVEL == 3:
global _KPS_ONLY_AW_
changedWeapon(_KPS_ONLY_AW_,player,weapon,1)
elif OLDSCHOOL_LEVEL == 4:
global _NO_UNLOCKS_FW_
changedWeapon(_NO_UNLOCKS_FW_,player,weapon,0)
elif OLDSCHOOL_LEVEL == 5:
pass
elif OLDSCHOOL_LEVEL == 6:
global _NO_SNIPERS_
changedWeapon(_NO_SNIPERS_,player,weapon,0)
else:
pass

if NO_C4 or NO_CLAYMORE or NO_MOUNTED_MGS or NO_TOW_MISSILE: changedWeaponMisc(player, weapon)

def sayAll(msg):
host.rcon_invoke("game.sayAll \"" + str(msg) + "\"")

def onRemoteCommand(playerId, cmd):
playerObject = bf2.playerManager.getPlayerByIndex(playerId)
playerName = playerObject.getName()
global ADMIN_LIST
if (str(playerName) in ADMIN_LIST):
execRconCmd(cmd)

def checkAndJudge(WeaponList,attacker,weapon,method):
if not (method):
if (str(weapon.templateName) in WeaponList): KickerSystem(attacker)
else:
if not (str(weapon.templateName) in WeaponList): KickerSystem(attacker)

def checkAndJudgeMisc(attacker, weapon):
global NO_C4, NO_CLAYMORE, NO_MOUNTED_MGS, NO_TOW_MISSILE
if ((NO_CLAYMORE and weapon.templateName == "usmin_claymore") or (NO_C4 and weapon.templateName == "c4_explosives") or (NO_MOUNTED_MGS and weapon.templateName == "rulmg_rpk74_stationary") or (NO_TOW_MISSILE and weapon.templateName == "ats_hj8_Launcher")): KickerSystem(attacker)

def KickerSystem(player):
global playerKickList, HOW_MANY_KILLS_TO_KICK, RESTRICTED_WEAPON_KICK_MSG, RESTRICTED_WEAPON_KICK_REASON, WARNING_AFTER_FRAG, RESTRICTED_WEAPON_KICK_IN_MINUTES
playerId = player.getProfileId()
t = 0
for temp_player in playerKickList:
if (int(playerId) == int(temp_player[0])):
temp_player[1]+=1;
if (temp_player[1] >= HOW_MANY_KILLS_TO_KICK):
host.sgl_sendTextMessage( 0, 12, 1, str(RESTRICTED_WEAPON_KICK_MSG) % (player.getName()), 0)
host.rcon_invoke("pb_sv_kick \""+str(player.getName())+"\" "+str(RESTRICTED_WEAPON_KICK_IN_MINUTES)+" \""+str(RESTRICTED_WEAPON_KICK_REASON)+"\"")
del playerKickList[playerKickList.index([playerId,temp_player[1]])]
t = 1

else:
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_AFTER_FRAG) % (player.getName()), 0)
t = 1

if not (t):
playerKickList.append([playerId, 1])
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_AFTER_FRAG) % (player.getName()), 0)
t = 0
def changedWeapon(WeaponList, player, weapon, method):
global PUNISH_METHOD, WARNING_LVL0, WARNING_LVL1
if not (method):
if (str(weapon.templateName) in WeaponList):
if not (PUNISH_METHOD):
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL0) % (player.getName()), 0)
else:
player.getDefaultVehicle().setDamage(0)
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL1) % (player.getName()), 0)
else:
if not (str(weapon.templateName) in WeaponList):
if not (PUNISH_METHOD):
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL0) % (player.getName()), 0)
else:
player.getDefaultVehicle().setDamage(0)
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL1) % (player.getName()), 0)

def changedWeaponMisc(player, weapon):
global NO_C4, NO_CLAYMORE, NO_MOUNTED_MGS, NO_TOW_MISSILE, PUNISH_METHOD, WARNING_LVL0, WARNING_LVL1
if ((NO_CLAYMORE and weapon.templateName == "usmin_claymore") or (NO_C4 and weapon.templateName == "c4_explosives") or (NO_MOUNTED_MGS and weapon.templateName == "rulmg_rpk74_stationary") or (NO_TOW_MISSILE and weapon.templateName == "ats_hj8_Launcher")):
if not (PUNISH_METHOD):
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL0) % (player.getName()), 0)
else:
player.getDefaultVehicle().setDamage(0)
host.sgl_sendTextMessage( 0, 12, 1, str(WARNING_LVL1) % (player.getName()), 0)

def isThirdArg(sc):
try:
if (sc[0] and sc[1] and sc[2]):
return True
except IndexError:
return False

def isInt(expression):
try:
int(expression)
return True
except ValueError:
return False

def execRconCmd(cmd):
sc = str(cmd).split()
if (sc[0] == "bfo"):
if not (isThirdArg(sc)):
if (sc[1] == "status"):
global RESTRICTED_WEAPON_KICK_IN_MINUTES, HOW_MANY_KILLS_TO_KICK, OLDSCHOOL_LEVEL, NO_C4, NO_CLAYMORE, NO_MOUNTED_MGS, NO_TOW_MISSILE, PUNISH_METHOD, ANTICOMMANDER, COMMANDER_AUTOKICK, COMMANDER_KICK_TIME_IN_MINUTES
host.rcon_invoke("game.sayAll \"MAIN CONFIG ==> OLDSCHOOL LEVEL: " + str(OLDSCHOOL_LEVEL) + ", PUNISH METHOD: " + str(PUNISH_METHOD) + ", NO CLAYMORE: " + str(NO_CLAYMORE) + ", NO C4: " + str(NO_C4) + ", NO MOUNTED MGS: " + str(NO_MOUNTED_MGS) + ", NO TOW: " + str(NO_TOW_MISSILE) + "\"")
host.rcon_invoke("game.sayAll \"PUNISH METHOD 2 KICKER SYSTEM ==> HOW MANY KILLS TO KICK: " + str(HOW_MANY_KILLS_TO_KICK) + ", RESTRICTED WEAPON KICK TIME: " + str(NO_C4) + "min.\"")
host.rcon_invoke("game.sayAll \"ANTICOMM ==> ANTICOMMANDER: " + str(ANTICOMMANDER) + ", COMMANDER AUTOKICK: " + str(COMMANDER_AUTOKICK) + ", COMMANDER KICK TIME: " + str(COMMANDER_KICK_TIME_IN_MINUTES) + "min.\"")
elif (sc[1] == "punish"):
global PUNISH_METHOD
host.rcon_invoke("game.sayAll \"BFO::: PUNISH METHOD: " + str(PUNISH_METHOD) + "\"")
elif (sc[1] == "olevel"):
global OLDSCHOOL_LEVEL
host.rcon_invoke("game.sayAll \"BFO::: OLDSCHOOL LEVEL: " + str(OLDSCHOOL_LEVEL) + "\"")
elif (sc[1] == "c4"):
global NO_C4
host.rcon_invoke("game.sayAll \"BFO::: NO C4: " + str(NO_C4) + "\"")
elif (sc[1] == "claymore"):
global NO_CLAYMORE
host.rcon_invoke("game.sayAll \"BFO::: NO CLAYMORE: " + str(NO_CLAYMORE) + "\"")
elif (sc[1] == "mgs"):
global NO_MOUNTED_MGS
host.rcon_invoke("game.sayAll \"BFO::: NO MOUNTED MGS: " + str(NO_MOUNTED_MGS) + "\"")
elif (sc[1] == "tow"):
global NO_TOW_MISSILE
host.rcon_invoke("game.sayAll \"BFO::: NO TOW MISSILE: " + str(NO_TOW_MISSILE) + "\"")
elif (sc[1] == "kick_frags"):
global HOW_MANY_KILLS_TO_KICK
host.rcon_invoke("game.sayAll \"BFO::: KICK PLAYER AFTER: " + str(HOW_MANY_KILLS_TO_KICK) + " FRAGS.\"")
elif (sc[1] == "kick_time"):
global RESTRICTED_WEAPON_KICK_IN_MINUTES
host.rcon_invoke("game.sayAll \"BFO::: KICK PLAYER FOR: " + str(RESTRICTED_WEAPON_KICK_IN_MINUTES) + " MIN.\"")
elif (sc[1] == "anticomm"):
global ANTICOMMANDER
host.rcon_invoke("game.sayAll \"BFO::: ANTI COMMANDER: " + str(ANTICOMMANDER) + "\"")
elif (sc[1] == "commkick"):
global COMMANDER_AUTOKICK
host.rcon_invoke("game.sayAll \"BFO::: COMMANDER AUTOKICKER: " + str(COMMANDER_AUTOKICK) + "\"")
elif (sc[1] == "commkick_time"):
global COMMANDER_KICK_TIME_IN_MINUTES
host.rcon_invoke("game.sayAll \"BFO::: KICK COMMANDER FOR: " + str(COMMANDER_KICK_TIME_IN_MINUTES) + " MIN.\"")
elif (sc[1] == "help"):
sayAll(" Ver 0.9 BETA Last changed: 25.Apr.2008")
sayAll(" For more info mail to: misiekbest@misiekbest.pl or visit website: http://bfo.misiekbest.pl")
sayAll("This help include all commands that can be executed in game console via rcon.")
sayAll("TO EXECUTE COMMAND TYPE IN CONSOLE: rcon bfo [command] [value].")
sayAll("")
sayAll("############## OLDSCHOOL LEVEL ##############")
sayAll("#############################################")
sayAll("olevel # Return number of oldschool level")
sayAll("olevel [value] # Set oldschool level to given value")
sayAll("Here are all oldschool levels:")
sayAll("0 - Scrpit completely disabled.")
sayAll("1 - ONLY MEDICS and MEDICS UNLOCKS")
sayAll("2 - ONLY MEDICS and NO MEDICS UNLOCKS")
sayAll("3 - ONLY KNIFE, PISTOL AND SHOCK PADDLES ALLOWED. NOTE: This level will only work with punish method set to 0 or 2")
sayAll("4 - NO UNLOCKS")
sayAll("5 - DONT USE OLDSCHOOL LEVEL, JUST CHECK OTHER THINGS LIKE NO C4 or NO CLAYMORE")
sayAll("6 - NO SNIPERS")
sayAll("")
sayAll("############## PUNISH METHOD ##############")
sayAll("############################################")
sayAll("punish # Return number of punish method")
sayAll("punish [value] # Set punish method to given value")
sayAll("Here are all punish methods:")
sayAll("0 - Only warning enabled. No other punishment")
sayAll("1 - Kill player just after respawn with forbidden weapon. If restricted are c4 or claymore player will die after switching to them. This wont work for mounted mgs and tow. Sorry.")
sayAll("2 - Kick player after previously given kick_frags variable. To set number of frags run: rcon bfo kick_frags [value]")
sayAll("")
sayAll("############## MISC WEAPONS ##############")
sayAll("##############################################")
sayAll("c4 # Return status of C4 restriction")
sayAll("c4 [value] # Enable or disble C4 restriction. 0-Disable 1-Enable")
sayAll("claymore # Return status of CLAYMORE restriction")
sayAll("claymore [value] # Enable or disble CLAYMORE restriction. 0-Disable 1-Enable")
sayAll("mgs # Return status of MOUNTED MGS restriction")
sayAll("mgs [value] # Enable or disble MOUNTED MGS restriction. 0-Disable 1-Enable")
sayAll("tow # Return status of TOW MISSILE restriction")
sayAll("tow [value] # Enable or disble TOW MISSILE restriction. 0-Disable 1-Enable")
sayAll("")
sayAll("############## KICKER SYSTEM (punish 2) ##############")
sayAll("##########################################################")
sayAll("kick_frags # Return number of how many kills from restricted weapon to kick player")
sayAll("kick_frags [value] # Set HOW_MANY_KILLS_TO_KICK to given value")
sayAll("kick_time # Return minutes for how long player should be kicked out.")
sayAll("kick_time [value] # Set minutes for how long player should be kicked out.")
sayAll("")
sayAll("############## ANTI COMMANDER ##############")
sayAll("##################################################")
sayAll("anticomm # Return status of ANTICOMMANDER system")
sayAll("anticomm [value] # Enable or disble commander restriction. 0-Disable 1-Enable")
sayAll("commkick # Return status of COMMANDER KICKER system")
sayAll("commkick [value] # Enable or disble commander kicking. 0-Disable 1-Enable")
sayAll("commkick_time # Return minutes for how long commander should be kicked out.")
sayAll("commkick_time [value] # Set minutes for how long commander should be kicked out.")
sayAll("")
sayAll("")
sayAll("")
sayAll("")
sayAll("HELP GENERATED. NOW OPEN YOUR CONSOLE TO SEE IT. YOU CAN NAVIGATE UP AND DOWN BY PRESSING PAGE UP AND PAGE DOWN ON YOUR KEYBOARD")
else:
host.rcon_invoke("game.sayAll \"BFO::: !!!!ERROR!!!! Unknown command : " + str(sc[1]) + "\"")
host.rcon_invoke("game.sayAll \"BFO::: Use: status, punish, olevel, c4, claymore, mgs, tow, kick_frags, kick_time, anticomm, commkick, commkick_time\"")
else:
if (isInt(sc[2])):
if (sc[1] == "punish"):
if (0<=int(sc[2])<=2):
global PUNISH_METHOD
PUNISH_METHOD = int(sc[2])
if (PUNISH_METHOD == 0 or PUNISH_METHOD == 1):
try:
host.registerHandler('PlayerChangeWeapon', onPlayerChangeWeapon, 1)
except:
pass
else:
try:
host.registerHandler('PlayerKilled', onPlayerKilled, 1)
except:
pass
host.rcon_invoke("game.sayAll \"BFO::: PUNISH METHOD SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! Punish method must be 0, 1 or 2 ")
elif (sc[1] == "olevel"):
if (0<=int(sc[2])<=6):
global OLDSCHOOL_LEVEL
OLDSCHOOL_LEVEL = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: OLDSCHOOL LEVEL SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! oldschool level must be 0, 1, 2, 3, 4, 5 or 6")
elif (sc[1] == "c4"):
if (0<=int(sc[2])<=1):
global NO_C4
NO_C4 = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: NO C4 SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! C4 can be set only to 0 or 1")
elif (sc[1] == "claymore"):
if (0<=int(sc[2])<=1):
global NO_CLAYMORE
NO_CLAYMORE = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: NO CLAYMORE SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! CLAYMORE can be set only to 0 or 1")
elif (sc[1] == "mgs"):
if (0<=int(sc[2])<=1):
global NO_MOUNTED_MGS
NO_MOUNTED_MGS = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: NO MOUNTED MGS SET TO: " + str(sc[2]) + "\"")
sayAll("BFO::: !!!!ERROR!!!! MGS can be set only to 0 or 1")
elif (sc[1] == "tow"):
if (0<=int(sc[2])<=1):
global NO_TOW_MISSILE
NO_TOW_MISSILE = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: NO TOW MISSILE SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! TOW can be set only to 0 or 1")
elif (sc[1] == "kick_frags"):
if (0<=int(sc[2])):
global HOW_MANY_KILLS_TO_KICK
HOW_MANY_KILLS_TO_KICK = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: HOW MANY KILLS TO KICK SET TO: " + str(sc[2]) + " FRAGS\"")
else:
sayAll("BFO::: !!!!ERROR!!!! KICK_FRAGS must be greater than or equal to 0")
elif (sc[1] == "kick_time"):
if (0<=int(sc[2])):
global RESTRICTED_WEAPON_KICK_IN_MINUTES
RESTRICTED_WEAPON_KICK_IN_MINUTES = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: KICK PLAYER TIME SET TO: " + str(sc[2]) + " MIN.\"")
else:
sayAll("BFO::: !!!!ERROR!!!! KICK_TIME must be greater than or equal to 0")
elif (sc[1] == "anticomm"):
if (0<=int(sc[2])<=1):
global ANTICOMMANDER
ANTICOMMANDER = int(sc[2])
if (ANTICOMMANDER == 1):
try:
host.registerHandler('ChangedCommander', onCommander, 1)
except:
pass
host.rcon_invoke("game.sayAll \"BFO::: ANTI COMMANDER SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! ANTICOMM can be set only to 0 or 1")
elif (sc[1] == "commkick"):
if (0<=int(sc[2])<=1):
global COMMANDER_AUTOKICK
COMMANDER_AUTOKICK = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: COMMANDER AUTOKICK SET TO: " + str(sc[2]) + "\"")
else:
sayAll("BFO::: !!!!ERROR!!!! COMMKICK can be set only to 0 or 1")
elif (sc[1] == "commkick_time"):
if (0<=int(sc[2])):
global COMMANDER_KICK_TIME_IN_MINUTES
COMMANDER_KICK_TIME_IN_MINUTES = int(sc[2])
host.rcon_invoke("game.sayAll \"BFO::: COMMANDER KICK TIME SET TO: " + str(sc[2]) + " MIN.\"")
else:
sayAll("BFO::: !!!!ERROR!!!! COMMKICK_TIME must be greater than or equal to 0")
else:
host.rcon_invoke("game.sayAll \"BFO::: !!!!ERROR!!!! Unknown command : " + str(sc[2]) + "\"")
host.rcon_invoke("game.sayAll \"BFO::: Use: punish, olevel, c4, claymore, mgs, tow, kick_frags, kick_time, anticomm, commkick, commkick_time\"")
else:
host.rcon_invoke("game.sayAll \"BFO::: !!!!ERROR!!!! Third argument must be numerical ammount! You wrote: " + str(sc[2]) + "\"")

def onGameStatusChange(status):
if (status == bf2.GameStatus.EndGame):
global playerKickList
playerKickList = []
</pre>

Scripts:ThreatAndWorth

2018-06-22T15:33:40Z

Pireax: Created page with "__TOC__ == Description == ; Module : <code>ThreatAndWorth.py</code> ; Author : SHAnders ; Version : 1.01 Server side only admin script or mod addon, you deside the usage!..."

__TOC__
== Description ==

; Module
: <code>ThreatAndWorth.py</code>
; Author
: SHAnders
; Version
: 1.01

Server side only admin script or mod addon, you deside the usage!

== Features ==

=== Worth ===

This script will reward player kills based upon a worth schema. Each players will be assigned a 'worth' when they get killed or kill. If victim worth > attacker worth, the attacker is assigned a bonus. Worth is calculated by vehicle, and players position within it plus an addition if player is squadleader or commander, snipers are worth only to other snipers.

=== Threat ===

This script implements threat rating. The lower the attacker threat raking and the higher the victim threat rating, the higher the bonus and vice versa. Threat rating is based uppon a calculation of a player kills, deaths and scores compared to the average player in the game. Threat rating can be disabled by setting: <code>USE_THREAT_RATING = False</code>.

=== Survival ===

At the end of the game players will be rewarded upon their survival rating. The more enemies you kill and the less you get killed, the higher the bonus.

Survivalrating can be disabled by setting : <code>USE_SURVIVAL_RATING = False</code>

=== Commander ===

To please a few people out there it is now possible to disable the commander in this script.

Commander can be disabled by setting: <code>DISABLE_COMMANDER = True</code>

== Installation ==

Installation as Admin script -- not a mod, adds scoring changes to all games on server:

# Save this script as <code>ThreatAndWorth.py</code> in your <code>admin/standard_admin</code> directory.
# Add the lines <code>import ThreatAndWorth</code> and <code>ThreatAndWorth.init()</code> to the file <code>admin/standard_admin/__init__.py</code>.

Installation as Mod addon -- adds scoring changes only to your mod:

# Save this script as <code>ThreatAndWorth.py</code> in your <code>mods/<mod_lib>/python/game</code> directory.
# Add the lines <code>import ThreatAndWorth</code> and <code>ThreatAndWorth.init()</code> to the file <code>mods/<mod_lib>/python/game/__init__.py</code>.

== TODO: ==

; Team score
: Additional points for actions made within 30-50 feet of a commander/squadleader attack/defend/fix/blowup/asembly order

== Thanks To ==

Battlefield.no for inspiration from their pingkick.py script

== The Code ==

<code> </code>

<code> </code><pre>
# ------------------------------------------------------------------------
# Module: ThreatAndWorth.py
# Author: SHAnders
#
# Version 1.01
# Changes
# 1.0 -> 1.01
# Updated the messagetimer to only start once
#
# Description:
# Server side only admin script or mod addon, you deside the usage !
#
# This script will reward player kills based uppon a worthschema
# Each players will be assigned a 'worth' when they get killed or kill
# If victim worth > attacker worth, the attacker is assigned a bonus.
# Worth is calculated by vehicle, and players position within it plus
# an addition if player is squadleader or commander, snipers are worth only to other snipers.
#
# This script implement threat rating. The lower the attacker threat raking
# and the higher the victim threat rating, the higher the bonus and vice versa.
# Threat rating is based uppon a calculation of a player kills, deaths & scores
# compared to the average player in the game.
#
# At the end of the game players will be rewarded uppon their survival rating.
# The more enemies you kill and the less you get killed, the higher the bonus.
#
# To please a few people out there it is now posible to disable the commander in this script.
#
# The scoring system provided by ThreatAndWorth refines the idear and system
# implemted by the earlier scoringBonuses v1.0
# ThreatAndWorth therfor replaces the scoringBonuses script.
#
# Requirements:
# None.
#
# Installation as Admin script -- Not a mod, adds scoring changes to all games on server:
# 1: Save this script as 'ThreatAndWorth.py' in your <bf2>/admin/standard_admin directory.
# 2: Add the lines 'import ThreatAndWorth' and 'ThreatAndWorth.init()' to the file
# '<bf2>/admin/standard_admin/__init__.py'.
#
# Installation as Mod addon -- adds scoring changes only to your mod:
# 1: Save this script as 'ThreatAndWorth.py' in your <bf2>/mods/<mod_lib>/python/game directory.
# 2: Add the lines 'import ThreatAndWorth' and 'ThreatAndWorth.init()' to the file
# '<bf2>/mods/<mod_lib>/python/game/__init__.py'.
#
# TODO:
# Team score:
# Additional points for actions made within 30-50 feet of a commander/squadleader
# attack/defend/fix/blowup/asembly order
#
# Thanks to:
# Battlefield.no for inspiration from their pingkick.py script
#
# ------------------------------------------------------------------------

import host
import bf2
from bf2.stats.constants import *
from bf2 import g_debug
from bf2.stats.stats import onGameStatusChanged

# ------------------------------------------------------------------------
# Constants
# ------------------------------------------------------------------------

WORTHSCHEMA = { VEHICLE_TYPE_ARMOR : [ 6, 3, 1, 1, 1, 1, 1, 1 ],
VEHICLE_TYPE_AVIATOR : [ 8, 3, 1, 1, 1, 1, 1, 1 ],
VEHICLE_TYPE_AIRDEFENSE : [ 1 ],
VEHICLE_TYPE_HELICOPTER : [ 6, 3, 3, 1, 1, 1, 1, 1 ],
VEHICLE_TYPE_TRANSPORT : [ 3, 3, 1, 1, 1, 1, 1, 1 ],
VEHICLE_TYPE_ARTILLERY : [ 1 ],
VEHICLE_TYPE_GRNDDEFENSE : [ 1 ],
VEHICLE_TYPE_PARACHUTE : [ 1 ],
VEHICLE_TYPE_SOLDIER : [ 0 ] } # index 0 is allways used for victim, 0-7 are all used for attacker

# Aditional worth, only the greatest applies
VICTIM_SNIPER = 2 # Only applies when attacker is sniper
VICTIM_SQUADLEADER = 4 # Killing a squadleader in a jet gives good points, But why would he/she be there anyway ... squad members cant spawn there?
VICTIM_COMMANDER = 6 # Killing a commander in a jet gives good points, But why would he/she be there anyway ... should he/she not bee doing something else?

DEFAULT_VICTIM_WORTH = 1 # Victim will allways be worth this + whats in the WORTHSCHEMA
USE_THREAT_RATING = True # Low threat rated players get more points for kills on higher threat rated players [True, False]
PUBLIC_SCORES = 1 # Score earnings will be made public to the following: [0 = None, 1 = Team, 2 = All]
USE_SURVIVAL_RATING = True # At end game players with high survivalrating will be rewarded with (SurvivalRating * (kills - deaths) / restraint) [True, False]
SURVIVAL_RATING_RESTRAINT = 3 # The higher the number, the lower the bonus (without it the bonus can get very high) [1..*]
DISABLE_COMMANDER = False # Not all like the commander, setting this to True will disable this posibility [True, False]

WELCOME_MSG = "Server is using ThreatAndWorth script v1.0"

# ------------------------------------------------------------------------
# Variables
# ------------------------------------------------------------------------

MsgTimer = None # Welcome msg Timer

# ------------------------------------------------------------------------
# Init
# ------------------------------------------------------------------------
def init():
host.unregisterGameStatusHandler(onGameStatusChanged) # We need to unregister this to change endscores
host.registerGameStatusHandler(onGameStatusChangedThreatAndWorth)
host.registerGameStatusHandler(onGameStatusChanged) # We need to register it again after our own handler to make the game work :)
MsgTimer = bf2.Timer(onMsgTimer,10,1)
if g_debug: print "ThreatAndWort init"
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# onGameStatusChangedThreatAndWorth
# ------------------------------------------------------------------------
def onGameStatusChangedThreatAndWorth(status):
if status == bf2.GameStatus.Playing:
host.registerHandler('PlayerKilled', onPlayerKilled)
if DISABLE_COMMANDER:
host.sh_setEnableCommander(0)

elif status == bf2.GameStatus.EndGame:
if USE_SURVIVAL_RATING:
CalculateSurvivalRatingBonus()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# onPlayerKilled
# ------------------------------------------------------------------------
def onPlayerKilled(victim, attacker, weapon, assists, object):
victimVehicle = victim.getVehicle()

# killed by remote controlled vehicle, no score awarded in this game
if victimVehicle and victimVehicle.getIsRemoteControlled():
pass

# no attacker, killed by object
elif attacker == None:
pass

# killed by self
elif attacker == victim:
pass

# killed by own team
elif attacker.getTeam() == victim.getTeam():
pass

# killed by enemy
else:
CalculateThreatAndWorth(attacker, victim)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# addBonus
# ------------------------------------------------------------------------
def addBonus(player, points):
# commander doesnt get bonus for regular actions, only for pure commander tasks.
if not player.isCommander():
player.score.score += points

# commander score
commander = bf2.playerManager.getCommander(player.getTeam())
if commander != None and commander.isValid() and player != commander and points > 0:
preScore = commander.score.score
numPlayers = bf2.playerManager.getNumberOfAlivePlayersInTeam(commander.getTeam())
if numPlayers > 0:
commander.score.score += float(points) / numPlayers
scoreGotten = commander.score.score - preScore
if scoreGotten > 0:
commander.score.cmdScore += scoreGotten
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for timer, that delays a message at round start:
# I hope the fellows at Battlefield.no dont mind me using this !
# ------------------------------------------------------------------------
def onMsgTimer(data):
global msgtimer
sendMsgAll( WELCOME_MSG )
msgtimer.destroy()
msgtimer = None
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send message to all on server
# ------------------------------------------------------------------------
def sendMsgAll(msg):
host.rcon_invoke("game.sayAll \"" + str(msg) + "\"")
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send message to all on a team
# ------------------------------------------------------------------------
def sendMsgTeam(msg, team):
host.rcon_invoke("game.sayTeam " + str(team) + " \"" + str(msg) + "\"")
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Calculate survival endgame points
# ------------------------------------------------------------------------
def CalculateSurvivalRatingBonus():
playerArgs = bf2.playerManager.getPlayers()
for p in playerArgs:
survivalRating = GetPlayerSurvivalRating(p)
if survivalRating > 0:
points = round((p.score.kills - p.score.deaths) * survivalRating / SURVIVAL_RATING_RESTRAINT, 0)
addBonus(p, int(points))
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Get a players survival rating
# ------------------------------------------------------------------------
def GetPlayerSurvivalRating( player ):
kills = float(player.score.kills + 1)
deaths = float(player.score.deaths + 1)
survivalRating = kills / deaths
return round(survivalRating, 2)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Calculate threat and worth points
# ------------------------------------------------------------------------
def CalculateThreatAndWorth(attacker, victim):
victimVehicle = victim.getVehicle()
victimRootVehicle = getRootParent(victimVehicle)
attackerVehicle = attacker.getVehicle()
attackerRootVehicle = getRootParent(attackerVehicle)

points = 0

attackerWorth = GetPlayerWorth( attacker )
victimWorth = GetPlayerWorth( victim ) + GetAdditionalVictimWorth(attacker, victim)

tmpPoints = victimWorth - attackerWorth
if tmpPoints > 0:
if USE_THREAT_RATING:
attackerThreatRating = GetPlayerThreatRating( attacker )
victimThreatRating = GetPlayerThreatRating( victim )
threatRatingFactor = round((victimThreatRating / attackerThreatRating),3)
if threatRatingFactor < 0.125:
threatRatingFactor = 0
if threatRatingFactor < 0.25:
threatRatingFactor = 0.125
elif threatRatingFactor < 0.5:
threatRatingFactor = 0.25
elif threatRatingFactor < 0.75:
threatRatingFactor = 0.5
elif threatRatingFactor < 1.5:
threatRatingFactor = 1
elif threatRatingFactor < 2:
threatRatingFactor = 1.5
else:
threatRatingFactor = 2
tmpPoints = int(round( threatRatingFactor * tmpPoints,0))
points = tmpPoints
if points > 0:
addBonus(attacker, points)
if PUBLIC_SCORES == 2:
sendMsgAll( attacker.getName() + " earn points: " + str(points))
elif PUBLIC_SCORES == 1:
sendMsgTeam( attacker.getName() + " earn points: " + str(points), attacker.getTeam())
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Calculate additional victim worth
# ------------------------------------------------------------------------
def GetAdditionalVictimWorth(attacker, victim):
attackerKitType = getKitType(attacker.getKit().templateName)
attackerVehicle = attacker.getVehicle()
attackerVehicleType = getVehicleType(attackerVehicle.templateName)

victimKitType = getKitType(victim.getKit().templateName)
victimVehicle = victim.getVehicle()
victimVehicleType = getVehicleType(victimVehicle.templateName)

attackerTeamMsg = ""
victimTeamMsg = ""

worth = DEFAULT_VICTIM_WORTH

# SNIPER
if attackerVehicleType == VEHICLE_TYPE_SOLDIER:
if victimVehicleType == VEHICLE_TYPE_SOLDIER:
if attackerKitType == KIT_TYPE_SNIPER and victimKitType == KIT_TYPE_SNIPER:
worth += VICTIM_SNIPER
attackerTeamMsg = attacker.getName() + " has eliminated enemy sniper"

# SQUADLEADER
if victim.isSquadLeader():
worth += VICTIM_SQUADLEADER
attackerTeamMsg = attacker.getName() + " has eliminated a enemy squadleader " + victim.getName()

# COMMANDER
if victim.isCommander():
worth += VICTIM_COMMANDER
attackerTeamMsg = attacker.getName() + " has eliminated enemy commander " + victim.getName()
victimTeamMsg = "You commander has been eliminated"

if attackerTeamMsg != "":
sendMsgTeam(attackerTeamMsg, attacker.getTeam())

if victimTeamMsg != "":
sendMsgTeam(victimTeamMsg, victim.getTeam())

return worth
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Calculate a players worth
# ------------------------------------------------------------------------
def GetPlayerWorth( player ):
worth = -1
vehicle = player.getVehicle()
rootVehicle = getRootParent(vehicle)
vehicleType = getVehicleType(rootVehicle.templateName)
args = WORTHSCHEMA[vehicleType]
index = GetPlayerIndexInVehicle( player, rootVehicle )
if index > -1:
worth = args[index]
return worth
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Get a players index inside a vehicle
# ------------------------------------------------------------------------
def GetPlayerIndexInVehicle( player, vehicle ):
# This dosn't work on dead player/vehicles ... it allways return 0

playerArgs = vehicle.getOccupyingPlayers()
index = -1
found = False
while index < len(playerArgs) and not found:
index += 1
if playerArgs[index] == player:
found = True
return index
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Get a players threat rating
# ------------------------------------------------------------------------
def GetPlayerThreatRating( player ):
score = 0
kills = 0
deaths = 0
playerArgs = bf2.playerManager.getPlayers()
for p in playerArgs:
score += p.score.score
kills += p.score.kills
deaths += p.score.deaths

avgScore = float(score)/len(playerArgs)
avgKills = float(kills)/len(playerArgs)
avgDeaths = float(deaths)/len(playerArgs)

if player.score.score <= 0:
scoreFactor = 1/avgScore
else:
scoreFactor = float(player.score.score)/avgScore

if player.score.kills <= 0:
killsFactor = 1/avgKills
else:
killsFactor = float(player.score.kills)/avgKills

if player.score.deaths <= 0:
deathsFactor = avgDeaths/1
else:
deathsFactor = avgDeaths/float(player.score.deaths)

threatRating = round(killsFactor * deathsFactor * scoreFactor,3)

return threatRating
# ------------------------------------------------------------------------
</pre>

Scripts:ClanTkProtection

2018-06-22T15:33:18Z

Pireax: Created page with "This script is a modified version of the default tkpunish script. Clanmembers is a list of current members that will be protected This is the only code changed besides the de..."

This script is a modified version of the default tkpunish script.

Clanmembers is a list of current members that will be protected This is the only code changed besides the declare of the list.

<pre>
def onPlayerKilled(victim, attacker, weapon, assists, object):

string1 = attacker.getName()
#Is the attacker protected against punishments? If so, dont handle the event and return
for ncount in clanmembers:
if string1 == ncount: return
</pre>

<pre>
# tk punish system

import bf2
import host
from bf2 import g_debug

TK_PUNISH_TIME = 20

TK_PUNISH_COMMANDID = 100
TK_FORGIVE_COMMANDID = 101

hasPendingTks = {}
updateTimer = None

clanmembers = ["|TAG|Bill","|TAG|John","|TAG|Blue"]#clan members to protect

class TkData:
def __init__(self):
self.punished = 0
self.pending = []
self.lastTKedBy = None

def init():
if g_debug: print "initializing tk-punish script"

host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerKilled', onPlayerKilled)
host.registerHandler('ClientCommand', onClientCommand)

# Connect already connected players if reinitializing
for p in bf2.playerManager.getPlayers():
onPlayerConnect(p)

checkEnable()

def checkEnable():
global updateTimer

if not bf2.serverSettings.getTKPunishEnabled():
if updateTimer:
updateTimer.destroy()
updateTimer = None
return False
else:
if not updateTimer:
#if g_debug: print "Started timer"
updateTimer = bf2.Timer(onUpdate, 10, 1)
updateTimer.setRecurring(10)

return True

def onUpdate(data):
if not checkEnable(): return
global hasPendingTks

#if len(hasPendingTks) > 0:
# if g_debug: print "update: Has pending tks!"
#else:
# if g_debug: print "update:No pending tks."

currentTime = host.timer_getWallTime()

newPending = {}
for attacker in hasPendingTks.iterkeys():
newList = []
#if g_debug: print "attacker pending list:", len(attacker.tkData.pending)
for tk in attacker.tkData.pending:
tkDate = tk[0]
tkVictim = tk[1]
#if g_debug: print "check %d %s" % (tkDate, tkVictim.getName())

# if there is a pending TK with time expired
if tkDate + TK_PUNISH_TIME < currentTime:
if bf2.serverSettings.getTKPunishByDefault():
attacker.tkData.punished += 1
checkPunishLimit(attacker)
# if g_debug: print "Default punished ", attacker.getName()
else:
# if g_debug: print "Timeouted pending tk for ", attacker.getName()
pass

# remove player from global list, if it was the last tk
if len(attacker.tkData.pending) == 1:
pass
else:
newPending[attacker] = 1

else:
newList += [tk]
newPending[attacker] = 1

attacker.tkData.pending = newList

hasPendingTks = newPending

def checkPunishLimit(player):
#if g_debug: print "player %s has %d punishes" % (player.getName(), player.tkData.punished)

if player.tkData.punished >= bf2.serverSettings.getTKNumPunishToKick():
if g_debug: print "%s reached punish limit" % player.getName()
if g_debug: print "Banning player!"

result = host.rcon_invoke("admin.banPlayer " + str(player.index) + " Round")

# event actions

def onPlayerConnect(player):
player.tkData = TkData()

def onClientCommand(command, issuer, args):
if not checkEnable(): return

#if g_debug: print "received client command"
if command == TK_PUNISH_COMMANDID:
executePunishAction(issuer, True)
elif command == TK_FORGIVE_COMMANDID:
executePunishAction(issuer, False)

def onPlayerKilled(victim, attacker, weapon, assists, object):

string1 = attacker.getName()
#Is the attacker protected against punishments? If so, dont handle the event and return
for ncount in clanmembers:
if string1 == ncount: return

if not checkEnable(): return

if not victim or not attacker or victim == attacker or victim.getTeam() != attacker.getTeam(): return

# ok, we have a teamkill

currentTime = host.timer_getWallTime()
attacker.tkData.pending += [(currentTime, victim)]
hasPendingTks[attacker] = 1

victim.tkData.lastTKedBy = attacker # can only punish / forgive the last TK'er

bf2.gameLogic.sendClientCommand(victim.index, 100, (2, victim.index, attacker.index, TK_PUNISH_TIME))

def executePunishAction(victim, punish):
if not checkEnable() or not victim or not victim.isValid(): return
attacker = victim.tkData.lastTKedBy
if attacker == None or not attacker.isValid(): return

global hasPendingTks

if punish:
if g_debug: print "%s tkPunished %s" % (victim.getName(), attacker.getName())
else:
if g_debug: print "%s tkForgive %s" % (victim.getName(), attacker.getName())

currentTime = host.timer_getWallTime()

newList = []
for tk in attacker.tkData.pending:
tkDate = tk[0]
tkVictim = tk[1]

# if the attacker had a pending tk, and time has not run out
if tkVictim == victim and tkDate + TK_PUNISH_TIME > currentTime:
if punish:
attacker.tkData.punished += 1
bf2.gameLogic.sendClientCommand(-1, 100, (0, victim.index, attacker.index)) # 100 = tkpunish event, 0 = punish
if g_debug: print "%s punished %s, now has %d punishes" % (victim.getName(), attacker.getName(), attacker.tkData.punished)
else:
bf2.gameLogic.sendClientCommand(-1, 100, (1, victim.index, attacker.index)) # 100 = tkpunish event, 1 = forgive
if g_debug: print "%s forgave %s" % (victim.getName(), attacker.getName())
else:
newList += [tk]

attacker.tkData.pending = newList

if len(attacker.tkData.pending) == 0:
del hasPendingTks[attacker]

checkPunishLimit(attacker)
</pre>

Scripts:OfftimePy

2018-06-22T15:32:58Z

Pireax: Created page with "__TOC__ == What It Does == Allows you to have specific settings for when the number of players is below or equal to and above <code>sv.numPlayersNeededToStart</code>. For in..."

__TOC__
== What It Does ==

Allows you to have specific settings for when the number of players is below or equal to and above <code>sv.numPlayersNeededToStart</code>. For instance you can turn friendly-fire off and have instant spawn time when there aren't enough players to start a game.

== Installation ==

# Browse to <code>admin/standard_admin</code> in your bf2 server directory
# Edit <code>__init__.py</code> so it looks something like the code snippet below.
# Save the below code to <code>admin/standard_admin/offtime.py</code>.
# Make sure RCON is configured, then run your server. If "<code>offtime.py loaded</code>" comes up in your server console it should work from there.

== Usage ==

Edit the two dictionaries and add the settings you'd like each for each game state. The keys should be strings that represent <code>sv</code> settings and the values should be strings.

== Code ==

=== __init__.py ===

<pre>
import offtime

offtime.init()
</pre>

=== offtime.py ===

<pre>
# offtime.py - allows different settings for both
# sv.numPlayersNeededToStart-related game states
# -- by dackz (http://dackz.net/)
import bf2
import host
from bf2 import g_debug

# change these to reflect the settings you want
settingsNotStarted = {
'sv.soldierFriendlyFire': '0',
'sv.soldierSplashFriendlyFire': '0',
'sv.vehicleFriendlyFire': '0',
'sv.vehicleSplashFriendlyFire': '0',
'sv.spawnTime': '0',
'sv.manDownTime': '0',
}

settingsStarted = {
'sv.soldierFriendlyFire': '25',
'sv.soldierSplashFriendlyFire': '25',
'sv.vehicleFriendlyFire': '25',
'sv.vehicleSplashFriendlyFire': '25',
'sv.spawnTime': '13',
'sv.manDownTime': '13',
}

def init():
if g_debug: print 'initialising offtime script'

host.registerGameStatusHandler(onGameStatusChanged)

host.rcon_invoke('echo "offtime.py loaded"')

def onGameStatusChanged(status):
if status == bf2.GameStatus.Playing:
if bf2.playerManager.getNumberOfPlayers() < int(host.rcon_invoke('sv.numPlayersNeededToStart')):
host.rcon_invoke('echo "offtime.py: setting offtime setings"')
dictionary = settingsNotStarted
else:
host.rcon_invoke('echo "offtime.py: setting normal settings"')
dictionary = settingsStarted

for (setting, value) in dictionary.iteritems():
host.rcon_invoke('%s %s' % (setting, value))
</pre>

Scripts:MM MapAutoSizer

2018-06-22T15:32:09Z

Pireax: Created page with "__TOC__ == Introduction == After trying out Scripts:AutoMap and finding that it didn't do exactly what I wanted (and didn't seem to work with BF2 1.12),..."

__TOC__
== Introduction ==

After trying out [[Scripts:AutoMap|Scripts:AutoMap]] and finding that it didn't do exactly what I wanted (and didn't seem to work with BF2 1.12), I decided to write a plugin for the popular [[ModManager|ModManager]] package that comes with [http://www.bf2cc.com/ BF2CC]. The idea is based on [[Scripts:AutoMap|Scripts:AutoMap]], but there are some important differences:

* no randomizer
* the map rotation is read directly out of the BF2 server and not from maplist.con. This allows you to use this script even when you're changing your map rotation on the fly, without messing things up. It also allows map voting to work properly.
* map size thresholds are configurable through the modmanager configuration file

== Downloading ==

You can always find the most current version at the [http://www.gloryhoundz.com/code/ GloryHoundz Code Repository]. As of this writing, the latest version is 1.0 to be found here: [http://www.gloryhoundz.com/code/mm_mapautosizer/1.0/mm_mapautosizer.py mm_mapautosizer.py].

== Prerequisites ==

[[ModManager|ModManager]] or [http://www.bf2cc.com/ BF2CC]

== Install ==

* copy the file to ''admin/modules'' in your Battlefield 2 server install.
* change your ''modmanager.con'' and include the following line:

<pre>
''modmanager.loadModule "mm_mapautosizer"''
</pre>

* The default threshold for 32-size maps is 16 players and for 64-size maps it's 32 players. You can set your own thresholds by adding two configuration lines to ''modmanager.con'':

<pre>
''mm_mapautosizer.threshold_64 40''
''mm_mapautosizer.threshold_32 20''
</pre>

== Bugs/Comments ==

If you encounter any problems, stop by the [http://www.gloryhoundz.com/forums/ GloryHoundz Forums] and post about it.

== The Code ==
<pre>
# vim: ts=4 sw=4 noexpandtab
"""MapAutoSizer module

===== About =====
This ModManager script was created by GloryHoundz.com to allow for auto
sizing of maps in rotation based on the number of people on a server.

Inspired and partially based on the DontCamp.com dc_automap.py script from
http://bf2.fun-o-matic.org/index.php/Scripts:AutoMap

===== Config =====
# 64 Player map threshold. End of map number of players to trigger 64-size map
mm_mapautosizer.threshold_64 32

# 32 Player map threshold. End of map number of players to trigger 32-size map
mm_mapautosizer.threshold_32 16

===== History =====
v1.0 - 1/15/2006:
Initial public release: fixed map voting support

v0.9 - 1/08/2006:
Internal GloryHoundz.com release
"""

import bf2
import host
import mm_utils
import re

# Set the version of your module here
__version__ = 1.0

# Set the required module versions here
__required_modules__ = {
'modmanager': 1.0
}

# Does this module support reload ( are all its reference closed on shutdown? )
__supports_reload__ = True

# Set the description of your module here
__description__ = "MapAutoSizer v%s" % __version__

# Add all your configuration options here
configDefaults = {
'threshold_64': 32,
'threshold_32': 16
}

class MapAutoSizer( object ):

def __init__( self, modManager ):
# ModManager reference
self.mm = modManager

# Internal shutdown state
self.__state = 0

# Add any static initialisation here.
# Note: Handler registration should not be done here
# but instead in the init() method

def onGameStatusChanged(self, status):
"""Control Map rotation."""

threshold64 = self.__config['threshold_64']
threshold32 = self.__config['threshold_32']
if 1 != self.__state:
return 0

if status == bf2.GameStatus.EndGame:
host.rcon_invoke('echo "MapAutoSizer Initializing"')

rawMapRotation = host.rcon_invoke('maplist.list').split("\n")

mapRotation = []
for mapLine in rawMapRotation:
if mapLine:
mapParts = mapLine.split(" ")
if mapParts[1]:
mapRotation.append(mapParts[1])

nextMapIndex = int(host.rcon_invoke('admin.nextLevel'))
if nextMapIndex >= len(mapRotation):
nextMapIndex = 0
host.rcon_invoke('echo "MapAutoSizer next map index: %s"' % (nextMapIndex))

nextMap = mapRotation[nextMapIndex]
host.rcon_invoke('echo "MapAutoSizer next map: %s"' % (nextMap))

numPlayers = 0

for p in bf2.playerManager.getPlayers():
numPlayers += 1

host.rcon_invoke('echo "MapAutoSizer number of players: %s"' % (numPlayers))

if numPlayers >= threshold64:
mapSize = 64
if numPlayers < threshold64:
mapSize = 32
if numPlayers < threshold32:
mapSize = 16

host.rcon_invoke('echo "Changing map entry (index,name,size): (%s,%s,%s)"' % (nextMapIndex, nextMap, mapSize))
host.rcon_invoke('maplist.insert %s %s gpm_cq %d' % (nextMapIndex, nextMap, mapSize))
host.rcon_invoke('maplist.remove %s' % (nextMapIndex+1))
host.rcon_invoke('admin.setnextlevel %s' % (nextMapIndex))
host.rcon_invoke('echo "MapAutoSizer finished"')

def init( self ):
"""Provides default initialisation."""

# Load the configuration
self.__config = self.mm.getModuleConfig( configDefaults )

if 0 == self.__state:
# Register GameStatus event handler
host.registerGameStatusHandler(self.onGameStatusChanged)

# Update to the running state
self.__state = 1

def shutdown( self ):
"""Shutdown and stop processing."""

# Flag as shutdown as there is currently way to:
# host.unregisterHandler
self.__state = 2

# Unregister GameStatus event handler
host.unregisterGameStatusHandler(self.onGameStatusChanged)

def update( self ):
"""Process and update.
Note: This is called VERY often processing in here should
be kept to an absolute minimum.
"""
pass

def mm_load( modManager ):
"""Creates and returns the MapAutoSizer object."""
return MapAutoSizer( modManager )

</pre>

== Changelog ==

<pre>
v1.0 - 1/15/2006:
Initial public release: fixed map voting support
</pre>

<pre>
v0.9 - 1/08/2006:
Internal GloryHoundz.com release
</pre>

Scripts:SquadlessKick

2018-06-22T15:31:51Z

Pireax: Created page with "__TOC__ == Introduction == In an effort to learn Python and create something useful, I wrote this script to kick squadless players. It's a step towards a smoothly running te..."

__TOC__
== Introduction ==

In an effort to learn Python and create something useful, I wrote this script to kick squadless players. It's a step towards a smoothly running team.

== The Algorithm ==

Originally, the script performed a check when players died. However, this caused problems with the autobalancing system because the way BF2 triggers events when switching teams. When a player switches teams, he is removed from a squad (if it applies), killed, and switched to the other side. The problem with checking at player death is the autobalance triggers it when switching a player to another team. Of course, he will definitely not be in a squad and be kicked.

A better way of performing the check is on player spawn. This ensures the intention of whether the player wants to work in a squad or not. Combined with Python's ability to use lists as queues, squadless players can be processed at a specified interval after they spawn squadless.

When the player spawns, we want to perform the check and add the player to the queue if he is squadless. Setting a timer will perform a second check at a specified period after the player spawns.

<pre>
Player spawns
Player is not in a squad or not commanding
Player is added to a kick list
Player is issued a warning to join a squad
Set timer to kick player
</pre>

When the kick timer is triggered, we want to double-check that the player is still squadless. It's like a second chance. What we do is get the first player in the list and perform the check on him. This would be at the specified time after the player has spawned.

<pre>
Kick timer is triggered
Retrieve first player in kick list
Player is not in a squad or not commanding
Player is kicked from server
</pre>

We want to be fair and issue a general warning to all players every so often so they know to join a squad. If this timer is set to half the time of the kick timer, we can be sure that squadless players will see the warning at least once.

<pre>
Message timer is triggered
Display message to all players
</pre>

In between games, we want to clean up the message timer and clear the kick list. Everybody starts fresh on a new round!

<pre>
Game status changes
Game status is Playing
Set the message timer to trigger at set interval
Game status is PreGame
Destroy message timer
Clear the kick list
</pre>

== Code ==

<pre>
# Squadless Kick System

# Module: squadless_kick_v2.py
# Author: Sarc
# Version: 0.3a
# Description: Players not in a squad will be kicked from the server.
# An automated message will issue general warnings at specified intervals.
# Squadless player checks are done when the player spawns.

# Installation:
# Save this script, 'squadless_kick_v2.py', in your <bf2>/admin/standard_admin directory.
# Add 'import squadless_kick_v2' and 'squadless_kick_v2.init()' to the file '<bf2>/admin/standard_admin/__init__.py'.

import bf2
import host
from bf2 import g_debug

#debug flag
sks_debug = False # for verbose server console messages

#variable settings; intervals are in seconds
kickInterval = 60 # time before a squadless player is kicked
msgInterval = 30 # time between warning messages
warningMsg = "ADMIN: |c1000Squadless players will be kicked!" # the warning message

#timers
msgTimer = None

#queue lists
kickList = []

# Initialize the kick system i.e. register game hooks.
def init():
if g_debug: print "initializing squadless_kick script"

host.registerHandler('PlayerSpawn', onPlayerSpawn)
host.registerGameStatusHandler(onGameStatusChanged)

# On spawn, checks if the player is in a squad or commanding.
# Player is added to kick list if not in a squad or not commanding.
def onPlayerSpawn(p, vehicle):
global sks_debug
global kickList, kickInterval

if (p.getSquadId() == 0) and not p.isCommander():
# Add the player if not in kick list
if kickList.count(p.index) == 0:
kickList.append(p.index)

# Set timer for kick
bf2.Timer(onKickTimer, kickInterval, 1)

if sks_debug: host.rcon_invoke("echo \"" + p.getName() + " was added to the kick list.\"")

if sks_debug: host.rcon_invoke("echo \"Kick warning issued.\"")

# Issue kick warning
host.rcon_invoke("game.sayAll \"ADMIN: |c1000" + p.getName() + " will be kicked for not being in a squad\"")

# Sends out warning messages
def onMsgTimer(data):
global sks_debug
global warningMsg

host.rcon_invoke("game.sayAll \"" + warningMsg + "\"")

if sks_debug: host.rcon_invoke("echo \"Warning message issued.\"")

# Processes the kick list queue. The next player in queue
# is checked again and kicked if not in a squad or not commanding.
def onKickTimer(data):
global sks_debug
global kickList

if sks_debug: host.rcon_invoke("echo \"Kick timer triggered.\"")

# Process the next player in queue.
p = bf2.playerManager.getPlayerByIndex(kickList.pop(0))

# Player is still squadless, kick him.
if (p.getSquadId() == 0) and not p.isCommander():
host.rcon_invoke("echo \"" + p.getName() + " was kicked for not being in a squad\"")
host.rcon_invoke("admin.kickPlayer " + str(p.index))

# Handles clean up and initialization between rounds.
def onGameStatusChanged(status):
global kickList
global msgInterval, msgTimer

if status == bf2.GameStatus.Playing:
host.rcon_invoke("echo \"Game Status: Playing\"")

# Set the warning timer.
msgTimer = bf2.Timer(onMsgTimer, msgInterval, 1)
msgTimer.setRecurring(msgInterval)

elif status == bf2.GameStatus.PreGame:
host.rcon_invoke("echo \"Game Status: PreGame\"")

# Destroy any timers
msgTimer.destroy()
msgTimer = None

# Blank the list.
kickList = []

elif status == bf2.GameStatus.EndGame:
host.rcon_invoke("echo \"Game Status: EndGame\"")
</pre>

== History ==

0.1a

- Basic squadless kick functionality at death

- Warning message added

0.2a

- FIX: Players are not kicked when changing teams

- Warning message can be set at a user specified interval

- Kick list checks can be set at a user specified interval

0.3a

- FIX: Compatible with EA's autobalance script

- Checks are now done when a player spawns

- Message timer is destroyed when game ends and reinstantiated at game start

- Improved kick delay; now works by a queue for consistent kick delays

- Added debug flag for verbose server console messages

Scripts:Autoteam by Tickets

2018-06-22T15:31:28Z

Pireax: Created page with "__TOC__ == Introduction == I was toying with the idea of using the teamBalanceRatio server setting to alter the team balance based on team ticket counts. This script basical..."

__TOC__
== Introduction ==

I was toying with the idea of using the teamBalanceRatio server setting to alter the team balance based on team ticket counts. This script basically gives more people to the team with less tickets in inverse proportion to the ticket ratios. This little toy could be a real pain in the ass on servers where all users are eligible to be autoteamed, but some might find it useful anyway. We use it on our main server at [http://dontcamp.com/ Dontcamp.com] in conjuntion with a modified autoteam.py to basically put new players on the losing team. Should you want similar results, certain edits will have to be made to your autoteam.py. If you need more details, visit my website.

== What It Does ==

If autoteam balance is on, the sever setting sv.teamRatioPercent is adjusted according to the current ticket ratio in favor of the team with less tickets on every [[Event_Reference#Player_Events|PlayerKilled]] event. Regardless of the sv.autoBalanceTeam value, sv.teamRatioPercent is saved on every <code>[[Object_Reference#bf2.GameStatus|GameStatus.PreGame]]</code> Event, and restored on every <code>[[Object_Reference#bf2.GameStatus|GameStatus.EndGame]]</code> Event. There are various reasons for this, and most come from my inability to see if sv.autoBalanceTeam has been toggled at any point. There are workaround to this that are more elegant, but none that I can see are as efficient as this one.

== Comments ==

* I plan to add certain features to improve the user-friendliness of this script, such as stopping the automove when the team balance ratio gets to a certain degree, or if the game is coming to an end within 'x' tickets or 'y' seconds.

* As with all scripts I write, my comments suck. I apologize --dst 22:36, 28 Jul 2005 (MDT)

== dc_teamtickets.py ==

<pre>
#dontcamp.com Battlefield 2 auto team balance based on ticket ratio
# v1.2
#
# Place in admin/standard_admin/
# Add "import dc_teamtickets" and "dc_teamtickets.init()" to the __init__.py file in that directory.
# Once this is imported, if auto team balance is on, the team balance ratio will be set inverse to the ticket ratio.
#
import host
import bf2
from bf2 import g_debug

autobalance = 0
originalratio = 0

def init():
if g_debug: print 'initializing Dontcamp.com Team/Ticket manager'
host.registerHandler('PlayerKilled', onPlayerKilled, 1)
host.registerGameStatusHandler(onStatusChange)

#Check ticket ratio every time someone get killed
def onPlayerKilled(victimPlayerObject, attackerPlayerObject, weaponObject, assists, victimSoldierObject):
global autobalance
#if autobalance is off, don't change the ratio.
autobalance = int(bf2.serverSettings.getAutoBalanceTeam())
if autobalance:
t1tickets = host.sgl_getParam('tickets', 1, 0)
t2tickets = host.sgl_getParam('tickets', 2, 0)

try:
teamratio = int(float(t2tickets) / float(t1tickets) * 100)
#hardcoded a cap of balance ratios to prevent ridiculous team stacking by autoteam
#this is a 4/3 ratio
if teamratio > 133: teamratio = 133
if teamratio < 75: teamratio = 75
host.rcon_invoke('sv.teamRatioPercent %d' % teamratio)
except ZeroDivisionError:
pass

#Grab the teamratiopercent on pregame, reset it on endgame.
#Assuming that this is the only script messing with the ratio, all will be well.

def onStatusChange(status):
global originalratio
if status == bf2.GameStatus.PreGame:
originalratio = int(bf2.serverSettings.getTeamRatioPercent())
if status == bf2.GameStatus.EndGame:
host.rcon_invoke('sv.teamRatioPercent %d' % originalratio)
</pre>

== __init__.py ==

Add these lines:

<pre>
import dc_teamtickets
dc_teamtickets.init()
</pre>

Scripts:AutoMap

2018-06-22T15:31:12Z

Pireax: Created page with "__TOC__ == Introduction == With the 16/32/64 player map modes from BF2, I was upset to see that BF2 didn't support dynamic scaling of the map size based on the number of pla..."

__TOC__
== Introduction ==

With the 16/32/64 player map modes from BF2, I was upset to see that BF2 didn't support dynamic scaling of the map size based on the number of players connected. I went ahead and threw something together to fix this issue. It also randomizes the map cycle. The randomization feature is currently hardcoded into the script.

== What It Does ==

It gets its data from the server maplist file as defined in the server config file, defaulting to <code>mods/bf2/settings/maplist.con</code>, on every <code>[[Object_Reference#bf2.GameStatus|GameStatus.Playing]]</code> event thrown, so you can change it on the fly and invalid maps are still handled by the normal maplist parsing that hapens when bf2 loads up. It also sets the next map on this Event so that attempts to get the next map using 'admin.nextLevel' will succeed. The size of the map, however, is decided on <code>[[Object_Reference#bf2.GameStatus|GameStatus.EndGame]]</code> to ensure that the next map's size is set properly as close to the map change as possible.

== Comments ==

* Currently, if there's only one map in the maplist, a loop will start and never, ever stop. If nobody beats me to it, I'll fix it soon. --Dst 14:04, 28 Jul 2005 (MDT)

* If someone would be so kind as to make my commented instructions more user-friendly, I'd be very grateful. --Dst 14:04, 28 Jul 2005 (MDT)

== dc_automap.py ==

<pre>
#dontcamp.com Battlefield 2 automatic map changer/randomizer and maplist parser
#
# Place in admin/standard_admin/
# Add "import dc_automap" and "dc_automap.init()" to the __init__.py file in that directory.
# This works from the maps in your default maplist.con file. Please put more than one map in the file.
#
#
# Set this to prevent maps being loaded if it played "n" number of maps ago, including the current map.
maps_run_tracking = 3

import host
import bf2
import random
import re
from bf2 import g_debug

#init the maps_run list
maps_run = []

def init():
if g_debug: print 'initializing DontCamp.com Automatic Map Changer, Randomizer and Parser'

host.registerGameStatusHandler(onGameStatusChanged)

def onGameStatusChanged(status):
global next_map
global maps_run_tracking

if status == bf2.GameStatus.Playing:
current_map = bf2.gameLogic.getMapName()

match_pattern = re.compile(r'maplist.append "?(?P<map>.*?)"? "?gpm_[a-z]{2}"?( "?[0-9]{1,2}"?)?', re.I)
map_list = []
map_file = host.rcon_invoke('maplist.configFile')

lines = 0

for line in open(map_file.rstrip('\n')):
match = match_pattern.match(line)
map_list.append(match.group('map'))
lines += 1

if lines < maps_run_tracking: maps_run_tracking = lines - 1

maps_run.insert(0, current_map)
if len(maps_run) > maps_run_tracking: maps_run.pop()

next_map = current_map

while next_map in maps_run:
next_map = random.choice(map_list)

host.rcon_invoke('maplist.clear')
host.rcon_invoke('maplist.append %s gpm_cq' % (next_map))
host.rcon_invoke('admin.setnextlevel 0')

if g_debug: print 'Next level set to %s, size will be determined on EndGame' % (next_map)

if status == bf2.GameStatus.EndGame:
numplayers = 0

for p in bf2.playerManager.getPlayers():
numplayers += 1

if numplayers >= 40:
map_size = 64
if numplayers < 40:
map_size = 32
if numplayers < 20:
map_size = 16

host.rcon_invoke('maplist.clear')
host.rcon_invoke('maplist.append %s gpm_cq %d' % (next_map, map_size))
host.rcon_invoke('admin.setnextlevel 0')

if g_debug: print 'Next level set to %s (%d)' % (next_map, map_size)
</pre>

== __init__.py ==

Add these lines:

<pre>
import dc_automap
dc_automap.init()
</pre>

Scripts:AntiBaseRape

2018-06-22T15:30:49Z

Pireax: Created page with "__TOC__ == Description: == ; Module : <code>AntiBaseRape.py</code> ; Author : SHAnders ; Version : 1.11 Server side only admin script. This script will punish players who..."

__TOC__

== Description: ==

; Module
: <code>AntiBaseRape.py</code>
; Author
: SHAnders
; Version
: 1.11

Server side only admin script.

This script will punish players who kill enemy within the area of a safe base. (Control point that can't be captured.)

The punishment is the following:

# The victims death score will be lowered by 1
# The attackers kill score will will be lowered by 1
# The attackers overall score will be lowered by 2 + number of warnings
# If warnings > 3 then...

## The attackers TKs score will be increased by 1
## If attacker is on foot, he/she's health will be lowered to 0
## If attacker is in a vehicle, its health will be lowered to 1

1 warning will be removed from players history every 2 minutes

The radius for a safe base is set to 40. (Standard controlpoint capture area is 10.)

== Installation as Admin script ==

# Save this script as <code>AntiBaseRape.py</code> in your <code>admin/standard_admin</code> directory.
# Add the lines <code>import AntiBaseRape</code> and <code>AntiBaseRape.init()</code> to the file <code>admin/standard_admin/__init__.py</code>

== TODO: ==

Since not all maps are alike, the requirements for base rape protiction should be able to be altered individualy for each control point.

== The Code ==

<code> </code>

<code> </code><pre>
# ------------------------------------------------------------------------
# Module: AntiBaseRape.py
# Author: SHAnders
#
# Version 1.11
#
# Changes:
# v1.1 -> 1.11
# Fixed the timer to only be started once
# v1.0 -> 1.1
# Implemted a baseRapeWarning attribute on players to count safe base kills
# Implemted allowed amount of safe base kills (3)
# up to this amount player only loses kill points + 1 score pr baseRapeWarning
# over this amount player is allso killed
# Implemtes a timer for removing 1 baseRapeWarning every 2 minutes
#
# Description:
# Server side only admin script
#
# This script will punish players who kill enemy within the area of a safe base
#
# Requirements:
# None.
#
# Installation as Admin script:
# 1: Save this script as 'AntiBaseRape.py' in your <bf2>/admin/standard_admin directory.
# 2: Add the lines 'import AntiBaseRape' and 'AntiBaseRape.init()' to the file
# '<bf2>/admin/standard_admin/__init__.py'.
#
# TODO:
# Since not all maps are alike, the requirements for base rape protiction
# should be able to be altered individualy for each control point.
#
# Thanks to:
# Battlefield.no for inspiration from their pingkick.py script
#
# ------------------------------------------------------------------------

import host
import bf2
import math
from bf2.stats.constants import *
from bf2 import g_debug

# ------------------------------------------------------------------------
# Constants
# ------------------------------------------------------------------------

DEFAULT_SAFEBASE_RADIUS = 40 # Default safe area radius (normal commandpoint radius = 10)
ALLOWED_SAFEBASEKILLS = 3
SAFEBASEKILL_TIMER_INTERVAL = 120 # Intervals between removing a point from players.baseRapeWarning

# ------------------------------------------------------------------------
# Variables
# ------------------------------------------------------------------------

WarnReduceTimer = None # Timer that reduces the warnings at intervals

# ------------------------------------------------------------------------
# Init
# ------------------------------------------------------------------------

def init():
if g_debug: print "AntiBaseRape init"
host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerKilled', onPlayerKilled)

# Start the timer that reduces warnings on the SAFEBASEKILL_TIMER_INTERVAL
WarnReduceTimer = bf2.Timer(onSafeBaseKillTimer, SAFEBASEKILL_TIMER_INTERVAL, 1)
WarnReduceTimer.setRecurring(SAFEBASEKILL_TIMER_INTERVAL)

# Connect already connected players if reinitializing
for p in bf2.playerManager.getPlayers():
onPlayerConnect(p)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# onPlayerConnect
# ------------------------------------------------------------------------
def onPlayerConnect(player):
resetPlayer(player)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# onPlayerKilled
# ------------------------------------------------------------------------
def onPlayerKilled(victim, attacker, weapon, assists, object):
# killed by self
if attacker == victim:
pass

# killed by enemy
elif attacker != None and attacker.getTeam() != victim.getTeam():
checkForSafeBase(attacker, victim)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Reset the bfno pingscript variables placed in the player object:
# ------------------------------------------------------------------------
def resetPlayer(player):
player.baseRapeWarning = 0
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Check if victim was killed within safebase area
# ------------------------------------------------------------------------
def checkForSafeBase(attacker, victim):
victimVehicle = victim.getVehicle()
controlPoints = bf2.objectManager.getObjectsOfType('dice.hfe.world.ObjectTemplate.ControlPoint')
for cp in controlPoints:
if cp.cp_getParam('unableToChangeTeam') != 0 and cp.cp_getParam('team') != attacker.getTeam():
distanceTo = getVectorDistance(victimVehicle.getPosition(), cp.getPosition())
if DEFAULT_SAFEBASE_RADIUS > float(distanceTo):
justify(attacker, victim, cp, distanceTo)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Punish attacker, give victim life back and inform all
# ------------------------------------------------------------------------
def justify(attacker, victim, controlPoint, distanceTo):
victim.score.deaths += -1
attacker.score.kills += -1
attacker.score.score += -2 - attacker.baseRapeWarning
attacker.baseRapeWarning += 1
sendWarning(attacker, controlPoint, distanceTo)
if attacker.baseRapeWarning > ALLOWED_SAFEBASEKILLS:
attacker.score.TKs += 1
if attacker.isAlive():
vehicle = attacker.getVehicle()
rootVehicle = getRootParent(vehicle)
if getVehicleType(rootVehicle.templateName) == VEHICLE_TYPE_SOLDIER:
rootVehicle.setDamage(0)
# This should kill them !
else:
rootVehicle.setDamage(1)
# a vehicle will likely explode within 1 sec killing entire crew,
# not so sure about base defenses though
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send Warning
# ------------------------------------------------------------------------
def sendWarning(player, controlPoint, distanceTo):
mapName = bf2.gameLogic.getMapName()
if player.baseRapeWarning > ALLOWED_SAFEBASEKILLS:
sendMsgAll(player.getName() + " is punished for repeated violating of the no kill rules within safe base area")
else:
sendMsgAll(player.getName() + " has violated of the no kill rules within safe base area " + str(player.baseRapeWarning) + " times now")
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# remove baseRapeWarnings over time
# ------------------------------------------------------------------------
def onSafeBaseKillTimer(data):
for p in bf2.playerManager.getPlayers():
if p.baseRapeWarning <= 0:
p.baseRapeWarning = 0
else:
p.baseRapeWarning += -1
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# get distance between two positions
# ------------------------------------------------------------------------
def getVectorDistance(pos1, pos2):
diffVec = [0.0, 0.0, 0.0]
diffVec[0] = math.fabs(pos1[0] - pos2[0])
diffVec[1] = math.fabs(pos1[1] - pos2[1])
diffVec[2] = math.fabs(pos1[2] - pos2[2])

# Application of Pythagorean theorem to calculate total distance
return math.sqrt(diffVec[0] * diffVec[0] + diffVec[1] * diffVec[1] + diffVec[2] * diffVec[2])
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send message to all on server
# ------------------------------------------------------------------------
def sendMsgAll(msg):
host.rcon_invoke("game.sayAll \"" + str(msg) + "\"")
# ------------------------------------------------------------------------
</pre>

Scripts:TXT File base Automatic Announcements

2018-06-22T15:30:09Z

Pireax: Created page with "I just finished this and it's late, so I'm just going to throw it up and beef up the text later. It's pretty well documented, so you shouldn't have much trouble. Refer to Wood..."

I just finished this and it's late, so I'm just going to throw it up and beef up the text later. It's pretty well documented, so you shouldn't have much trouble. Refer to Woody's [[Scripts:Automatic_Announcements|Automatic Announcements]] script for installation. The only change to that being that I had to install the script in the admin/default.py script. This could've just been me, so keep in mind.

NOTE: By default, logging is turned off since the files can get large, You should enable logging if you are having a problem and you need to debug it.

<pre>
"""
advert.py - written by Dave Lawrence - thrash@fragnastika.com

Based on Woody's "Automatic Announcements" script
Loads messages from the text file "advert_msgs.txt"
Use one line per message
Log file can be used - advert_log.txt
NOTE: Only use the log file for debug. The output buffer is frequently
flushed to ensure you see timely debug messages. This *may* slow the
game server down
If you are having problems you can enable opt_SAdebug
This will allow the script to run outside BF2
There are no wrapers for the script, so the timer wont work, but you can
debug probs with the message file
NOTE: The advert_msgs.txt file is loaded into memory and I have no idea what'll
happen if you try to use an enormous file. Food for thought :)

Release notes:
advert.py v1.0

ToDo:
- Allow messages to be reloaded while the server is running (if that is even possible)
Perhaps a command from the console
Can anyone point me in the right direction on how to do this?
- Put the dbgWriter class into it's own py so we can use it everywhere!
"""

"""""""""""""""""""""""
Top-Level Imports
"""""""""""""""""""""""
import sys

"""""""""""""""""""""""
OPTIONS
"""""""""""""""""""""""
opt_Interval = 14 # Number of seconds between announcements
opt_SAdebug = 0 # For standalone debugging outside of bf2 enable this
# You can use this option to more easily figure out if your ads are loading

# Enable logging to advert_log.txt
# Warning: only do this for debugging. This log file could get huge!
opt_Debuglog = 0 # Logs to advert_log.txt
opt_Stdoutlog = 0 # Enable if you want ALL stdout msgs to be logged, you'll see the actual msh go out

"""""""""""""""""""""""
GLOBALS
"""""""""""""""""""""""
glob_dictMsgs = {} # Where all the advert messages are stored
glob_hdlDbgout = {}
glob_IdxMsg = 0

"""""""""""""""""""""""""""""""""
Functions and Classes
"""""""""""""""""""""""""""""""""
# This is where it happens :)
def tmrhdlAdvert(data):
global glob_IdxMsg
global glob_dictMsgs
# Handle the index overflow
if glob_IdxMsg >= len(glob_dictMsgs):
glob_IdxMsg = 0
host.rcon_invoke('game.sayall "%s"' % glob_dictMsgs[glob_IdxMsg])
dprint('game.sayall "%s"\n' % glob_dictMsgs[glob_IdxMsg], 1)
glob_IdxMsg += 1

class dbgWriter:
flog = {}
def __init__(self):
global glob_hdlDbgout
glob_hdlDbgout = self
if opt_Debuglog == 1 or opt_SAdebug == 0:
self.flog = open('advert_log.txt', 'w')
self.stream = self.flog
else:
self.stream = sys.stdout

# Do we modify STDOUT or leave it as the default cfg from somewhere else?
if opt_Stdoutlog == 1:
sys.stdout = self

def write(self, str):
self.stream.write(str)

def prt(self, str):
self.stream.write(str)

def flush(self):
self.stream.flush()

def dprint(msg, flush=0):
glob_hdlDbgout.prt(msg)
if flush == 1:
glob_hdlDbgout.flush()

"""""""""""""""""""""""""""""""""
Initialization and main code
"""""""""""""""""""""""""""""""""

# Init the debug writer
dbgWriter()

dprint("BF2 Advert Starting\n", 1)

# Check the interval and make sure it's not too short. Let's clamp it at 15 secs
if opt_Interval < 15:
dprint("opt_Interval=%s which is too small, changing to 15 seconds\n" % opt_Interval)
opt_Interval = 15

# TODO: There should be some way to auto detect if we're running inside the BF2 engine, hmm :-\
# Allows BF2 modules to be disabled for local debugging
if(opt_SAdebug == 0):
dprint("Importing BF2 libs\n", 1)
import bf2
import bf2.Timer
import host
else:
dprint("Running in standalone mode\n")

dprint("Importing advertisment messages\n", 1)
try:
try:
config = open('advert_msgs.cfg', 'rt')
except:
dprint("Error opening advert_msgs.cfg- Is it missing?\n")
for line_ in config:
line = line_.strip()
if len(line) == 0 or line.startswith('#'): continue
glob_dictMsgs[glob_IdxMsg] = line
dprint("%s\n" % glob_dictMsgs[glob_IdxMsg])
glob_IdxMsg += 1
except IOError:
dprint("I/O Error on advert.cfg read - does it exist?\n", 1)
pass

#Reset the glob_IdxMsg to point to the first message
glob_IdxMsg = 0

# Let's make sure that the timer gets initialized correctly
# It works now, but EA could "F" us later :)
try:
# We bypass this initialization if we're not running in BF2, this doesn;t *really* warrant a wrapper
if opt_SAdebug == 0:
timer = bf2.Timer(tmrhdlAdvert, opt_Interval, 1)
except:
dprint("'timer = bf2.Timer(tmrhdlAdvert, 1)' FAILED!!\n", 1)

try:
# We bypass this initialization if we're not running in BF2
if opt_SAdebug == 0:
timer.setRecurring(opt_Interval)
except:
dprint("'timer.setRecurring(optInterval))' FAILED!!\n", 1)

dprint("tmrhadlAdvert istalled successfully\n")
dprint("BF2 Advert Started %d messages\n" % len(glob_dictMsgs), 1)
</pre>

Just call it advert.py, save it in admin/ and add the following to your admin/__init__.py or admin/default.py

<pre>import advert </pre>

The advert_msgs.cfg file needs to be in the root BF2 directory. The log file, advert_log.txt will show up in the root BF2 folder as well.

Have fun!

Scripts:BF2Admin

2018-06-22T15:27:51Z

Pireax: Created page with "{{wip}} This script so far, should read a file for a list of administrators listed by their profileID. This administrator can then use chat commands to kick and ban players...."

{{wip}}

This script so far, should read a file for a list of administrators listed by their profileID. This administrator can then use chat commands to kick and ban players.

Last Update: 16:01, 10 Jul 2005 (CST)

__TOC__

== Documentation ==

Can be found in the [[Scripts:BF2Admin:Docs|BF2Admin Docs Page]]

== Changes ==

* Added sa_add_admin <player> <permissions> which will write new admins to the users.cfg,
* Added pub_id <player> which print the profileID of a player to the requesters console,
* Corrected the playername matching function to ignore case, e.g. "sa_kick dan bad guy" will kick a player with the name like FSR|Danni
* Added sa_rcon <rconcmd> <args> to allow rcon commands to be executed, the results are not reported back.
* Made the permissions work
* Added configuration system
* Added squad/ping kicker
* Added immunity perm

== To Do ==

* Reserved Slot for administrators,
* Rewrite the autobalancer to prioritze team switches,
* Administrator immunity from TKPunish
* Documentation (yeah right =P)

== Requests? ==

* Using key hash instead of player name as auth method. --Wizzler 19:50, 7 Jul 2005 (MDT)
''Actually, this method is nicer, as it ties the user back to their GameSpy ID and not to a certain install of BF2.''

== Bugs? ==

* ...
* ...
* ...

== Files ==

File: bf2admin.py

<pre>
# Ingame Administration System (BF2Admin)
#
# Author: Danni (webmaster@animelab.com)
# Clan: Fallen Soldiers Reborn
#
# http://www.fsrgaming.com
# http://www.animelab.com
#
#
# 100% Copyleft. Use at will but...
# If you reuse or modify this code you must credit me and
# the clan FSR. OR ELSE! >:D
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
# THIS MODULE IS NOT YET APPROVED FOR USE ON RANKED SERVERS!
# WE ARE NOT RESPONSIBLE FOR YOUR SERVER BEING DELISTED!
# PLEASE CHECK WITH EA FIRST BEFORE USING THIS MODULE ON A RANKED SERVER!
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
#
# Special thanks why?
# _________________________________________________________________
#
# Greeze Inspiration from SayKick.py
# DICE tk_punish.py and other BF2 python sources
# (unknown) gui_log.pyw a VERY helpfull tool!
# Everyone at BF2TIW http://bf2.fun-o-matic.org/index.php/Main_Page
#

import string
import re
import bf2
import bf2.PlayerManager
import bf2.Timer
import host
from bf2 import g_debug
import bf2admincmd
import bf2adminkickers

# Dictionaries. Duh!
pdict = { }
rcmd = { }
pcmd = { }
pinfo = { }
rinfo = { }
config = { }
log = None

# Logging Levels
L_NONE = 0
L_INFO = 1
L_WARNING = 2
L_ERROR = 3
L_DEBUG = 4

class AdminData:
def __init__(self):
self.admin = 0
self.perms = ""

class PlayerData:
def __init__(self):
self.lastupdate = 0
self.lastupdate = 0

### PlayerObject Extensions.

def getPlayerPerms(self):
return self.adminData.perms

def isAdmin(self):
return self.adminData.admin

def sendMessage(self, message):
host.sgl_sendTextMessage(self.index, 12, 1, message, 0)

bf2.PlayerManager.Player.isAdmin = isAdmin
bf2.PlayerManager.Player.getPerms = getPlayerPerms
bf2.PlayerManager.Player.sendMessage = sendMessage

def addChatCommand(command, function, perm, usage):
rcmd[command] = function
rinfo[command] = (perm, usage)

def addPublicChatCommand(command, function, usage):
pcmd[command] = function
pinfo[command] = usage

def setConfig(var, val):
config[var] = val

def getConfig(var):
if config.has_key(var):
return config[var]
else:
return False

def out(level, string):
global log
LOGLEVEL = ('[NONE]', '[INFO]', '[WARN]', '[ERROR]', '[DEBUG]')
if not config.has_key('logging'):
config['logging'] = 2
if not config.has_key('loglevel'):
config['loglevel'] = 3

string = LOGLEVEL[level] + ' ' + string
if level <= config['loglevel']:
if config['logging'] >= 1:
print string
if config['logging'] >= 2:
sendAdminMessage(string)
if config['logging'] >= 3:
log.write(string + "\n")

def loadConfig():
fn = 'admin/bf2admin.cfg'

try:
cfg = open(fn, 'r')
lineNo = 0

p = re.compile('(.*?):\s(.*?)', re.IGNORECASE)

for line in cfg:
lineNo += 1
if line.strip() != '' and line.strip() != '\n':
m = p.match(line)
if m:
config[m.group(1)] = m.group(2)

except IOError, detail:
out (L_WARNING, 'couldn\'t read "%s": %s' % (fn, detail))

def saveConfig():
fn = 'admin/bf2admin.cfg'

try:
cfg = open(fn, 'w')
lineNo = 0

keys = config.keys()
keys.sort()
for key in keys:
cfg.write(str(key) + ': ' + str(config[key]) + '\n')

except IOError, detail:
out(L_WARNING, 'couldn\'t write "%s": %s' % (fn, detail))

def sendAdminMessage(message):
for tp in bf2.playerManager.getPlayers():
if tp.adminData.admin:
host.sgl_sendTextMessage(playerId, 12, 1, message, 0)

def findPlayerFromString(playpart):
for tp in bf2.playerManager.getPlayers():
name = tp.getName()
playpart = playpart.lower()
name = name.lower()
if name.find(playpart) != -1:
return tp
return

def findPlayerNameFromString(playpart):
for tp in bf2.playerManager.getPlayers():
name = tp.getName()
playpart = playpart.lower()
name = name.lower()
if name.find(playpart) != -1:
return tp.getName()
return

def init():
global log
out(L_INFO, 'initializing BF2Admin script')
loadConfig()
parseUsers()
host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerDisconnect', onPlayerDisconnect, 1)
host.registerHandler('ChatMessage', onChatMessage, 1)

fn = 'admin/logs/bf2admin.log'
try:
log = open(fn, 'a')

except IOError, detail:
out(L_WARNING, 'couldn\'t open "%s": %s' % (fn, detail))

bf2admincmd.init()
bf2adminkickers.init()

def stripmessage(text):
text = text.replace("HUD_TEXT_CHAT_TEAM", "")
text = text.replace("HUD_TEXT_CHAT_SQUAD", "")
text = text.replace("HUD_CHAT_DEADPREFIX", "")
return text

def onChatMessage(playerid, text, channel, flags):
player = bf2.playerManager.getPlayerByIndex(playerid)
text = stripmessage(text)
cmdList = text.split(' ')

if len(cmdList) > 1 and playerid != -1:
cmd = cmdList[0]
cmdList[0:1] = []
args = string.join(cmdList,' ')
try:
if player.adminData.admin and rinfo[cmd]:
if player.adminData.perms.find(rinfo[cmd][0]) == -1:
player.sendMessage(player.index, 'BF2Admin: You have no access to that command')
else:
rcmd[cmd](player, args)
except Exception, detail:
out(L_DEBUG, 'Run-time error:' + detail)

try:
if pcmd[cmd] and pinfo[cmd]:
pcmd[cmd](player, args)
except Exception, detail:
out(L_DEBUG, 'Run-time error:' + detail)

def onPlayerConnect(player):
player.adminData = AdminData()
if pdict[str(player.getProfileId())]:
player.adminData.admin = 1
player.adminData.perms = str(pdict[str(player.getProfileId())])

# This is just in case a playerslot is reused and not initalized correctly.
# and yes I have seen it happen in other games =P

def onPlayerDisconnect(player):
player.adminData = AdminData()

# Parses the config file, if it's there
def parseUsers():
def boolFromString (str):
if str in ['True', 'true', '1']:
return True
elif value in ['False', 'false', '0']:
return False
else:
raise ValueError

fn = 'admin/users.cfg'
try:

# users.cfg format
# Note: playername is purly so the maintainer can tell who a line is for
#
#
# profileID "playername" "permissions" "reserved" "reserved" // Comment
#

cfg = open(fn, 'r')
lineNo = 0

# and now for some of that RegEx magic. ^_^

# profileid name perms resv resv
p = re.compile('\s*?([0-9]*?)\s\"(.*?)\"\s"(.*?)\"\s"(.*?)\"\s"(.*?)\"', re.IGNORECASE)

for line in cfg:
lineNo += 1
if line.strip() != '' and line.strip() != '\n':
m = p.match(line)
if m:
pdict[m.group(1)] = m.group(3)

except IOError, detail:
out(L_WARNING, 'couldn\'t read "%s": %s' % (fn, detail))
</pre>

File: bf2admincmd.py

<pre>
# Ingame Administration System (BF2Admin)
#
# Author: Danni (webmaster@animelab.com)
# Clan: Fallen Soldiers Reborn
#
# http://www.fsrgaming.com
# http://www.animelab.com
#
#
# 100% Copyleft. Use at will but...
# If you reuse or modify this code you must credit me and
# the clan FSR. OR ELSE! >:D
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
# THIS MODULE IS NOT YET APPROVED FOR USE ON RANKED SERVERS!
# WE ARE NOT RESPONSIBLE FOR YOUR SERVER BEING DELISTED!
# PLEASE CHECK WITH EA FIRST BEFORE USING THIS MODULE ON A RANKED SERVER!
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
#
# Special thanks why?
# _________________________________________________________________
#
# Greeze Inspiration from SayKick.py
# DICE tk_punish.py and other BF2 python sources
# (unknown) gui_log.pyw a VERY helpfull tool!
# Everyone at BF2TIW http://bf2.fun-o-matic.org/index.php/Main_Page
#

import string
import re
import bf2
import host
import bf2.PlayerManager
import bf2admin
from bf2 import g_debug
# Logging Levels
L_NONE = 0
L_INFO = 1
L_WARNING = 2
L_ERROR = 3
L_DEBUG = 4

def init():
bf2admin.out(L_INFO, 'initializing BF2AdminCmd script')
bf2admin.addChatCommand('sa_kick', sa_kick, 'k', 'sa_kick <player> <reason> - Kick a player')
bf2admin.addChatCommand('sa_ban', sa_ban, 'b', 'sa_ban <player> <length> <reason> - Ban a player')
bf2admin.addChatCommand('sa_bankey', sa_bankey, 'b', 'sa_bankey <player> <length> <reason> - Ban a player by CD-Key')
bf2admin.addChatCommand('sa_rcon', sa_rcon, 'r', 'sa_rcon <command> <args> ... - Send and rcon command')
bf2admin.addChatCommand('sa_add_admin', sa_add_admin, 'f', 'sa_add_admin <player> <permissions> ... - Add an administrator')
bf2admin.addChatCommand('sa_save', sa_save, 'f', 'sa_save <config> - Save the configuration')
bf2admin.addChatCommand('sa_set', sa_set, 'f', 'sa_set <key> <value> - Change a configuration option')
bf2admin.addChatCommand('sa_get', sa_get, 'f', 'sa_get <key> - Print a configuration option')

bf2admin.addPublicChatCommand('pub_id', pub_id, 'pub_id <player> - Retreave a players ProfileId')

def sa_kick(issuer, args):
argv = args.split(' ')
playername = bf2admin.findPlayerNameFromString(argv[0])
player = bf2admin.findPlayerFromString(argv[0])
argv[0:1] = []
reason = string.join(argv, ' ')
if playername:
if player.getPerms().find('i') != -1:
issuer.sendMessage('BF2Admin: ' + playername + ' is immune from that command')
else:
host.rcon_invoke('game.sayAll "BF2Admin: ' + playername + ' was kicked: ' + reason + '"')
host.rcon_invoke('admin.kickPlayer "' + playername + '"')

def sa_ban(issuer, args):
argv = args.split(' ')
if not argv[2]:
issuer.sendMessage("usage: sa_ban <player> <length> <reason>")
return
playername = bf2admin.findPlayerFromString(argv[0])
player = bf2admin.findPlayerFromString(argv[0])
length = int(argv[1])
argv[0:2] = []
reason = string.join(argv, ' ')
if playername:
if player.getPerms().find('i') != -1:
issuer.sendMessage('BF2Admin: ' + playername + ' is immune from that command')
else:
host.rcon_invoke('game.sayAll "BF2Admin: ' + playername + ' was banned: ' + reason + '"')
host.rcon_invoke('admin.banPlayer ' + player.index + ' ' + length)

def sa_bankey(issuer, args):
argv = args.split(' ')
if not argv[2]:
issuer.sendMessage("usage: sa_bankey <player> <length> <reason>")
return
playername = bf2admin.findPlayerFromString(argv[0])
player = bf2admin.findPlayerFromString(argv[0])
length = int(argv[1])
argv[0:2] = []
reason = string.join(argv, ' ')
if playername:
if player.getPerms().find('i') != -1:
issuer.sendMessage('BF2Admin: ' + playername + ' is immune from that command')
else:
host.rcon_invoke('game.sayAll "BF2Admin: ' + playername + '\'s CD-KEY was banned: ' + reason + '"')
host.rcon_invoke('admin.banPlayerKey ' + player.index + ' ' + length)

def sa_save(issuer, args):
bf2admin.saveConfig()
issuer.sendMessage('BF2Admin: Configuration Saved')

def sa_set(issuer, args):
argv = args.split(' ')
bf2admin.setConfig(argv[0], argv[1])

def sa_get(issuer, args):
issuer.sendMessage('BF2Admin: ' + str(args) + ': ' + str(bf2admin.getConfig(args)))

def sa_add_admin(issuer, args):
# sa_add_admin playerName permissions
argv = args.split(' ')
playername = bf2admin.findPlayerNameFromString(argv[0])
player = bf2admin.findPlayerFromString(argv[0])
profileId = player.getProfileId()
if player.getPerms():
issuer.sendMessage('BF2Admin: ' + playername + ' is already an administrator. Please edit the users.cfg file manualy to change permissions')
else:
file = open('admin/users.cfg', 'a')
file.write(' ' + str(profileId) + ' "' + playername + '" "' + argv[1] +'" "" ""\n')
file.close()
issuer.sendMessage('BF2Admin: ' + playername + ' added as an administrator.')

def sa_rcon(issuer, args):
argv = args.split(' ')
argv[0:1] = []
reason = string.join(argv, ' ')
res = host.rcon_invoke(args)
issuer.sendMessage('BF2Admin: rcon command issued')
for line in res.split('\n'):
issuer.sendMessage(line)

def pub_id(issuer, args):
argv = args.split(' ')
tp = bf2admin.findPlayerFromString(argv[0])
if tp:
issuer.sendMessage('BF2Admin: Name: ' + str(tp.getName()) + ' ProfileId: ' + str(tp.getProfileId()))
else:
issuer.sendMessage('BF2Admin: Error: Could not find a player with that name')

def pub_help(issuer, args):
argv = args.split(' ')
tp = bf2admin.findPlayerFromString(argv[0])
if tp:
issuer.sendMessage('BF2Admin: Name: ' + str(tp.getName()) + ' ProfileId: ' + str(tp.getProfileId()))
else:
issuer.sendMessage('BF2Admin: Error: Could not find a player with that name')
</pre>

File: bf2adminkickers.py

<pre>
# Ingame Administration System (BF2Admin)
#
# Author: Danni (webmaster@animelab.com)
# Clan: Fallen Soldiers Reborn
#
# http://www.fsrgaming.com
# http://www.animelab.com
#
#
# 100% Copyleft. Use at will but...
# If you reuse or modify this code you must credit me and
# the clan FSR. OR ELSE! >:D
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
# THIS MODULE IS NOT YET APPROVED FOR USE ON RANKED SERVERS!
# WE ARE NOT RESPONSIBLE FOR YOUR SERVER BEING DELISTED!
# PLEASE CHECK WITH EA FIRST BEFORE USING THIS MODULE ON A RANKED SERVER!
#
# WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!
#
#
# Special thanks why?
# _________________________________________________________________
#
# Greeze Inspiration from SayKick.py
# DICE tk_punish.py and other BF2 python sources
# (unknown) gui_log.pyw a VERY helpfull tool!
# Everyone at BF2TIW http://bf2.fun-o-matic.org/index.php/Main_Page
#

import string
import re
import bf2
import bf2.PlayerManager
import bf2.Timer
import host
from bf2 import g_debug
import bf2admin

gamestatus = None
ten_secs = None
sixty_secs = None

bf2.PlayerManager.Player.pingWarnings = 0
bf2.PlayerManager.Player.squadWarnings = 0
bf2.PlayerManager.Player.detectedPing = []
bf2.PlayerManager.Player.pingSamples = 0
bf2.PlayerManager.Player.actuallyPlaying = False

try:
def resetPlayer(p):
p.pingWarnings = 0
p.squadWarnings = 0
p.detectedPing = []
p.pingSamples = 0
p.actuallyPlaying = False

def init():
# defaults
if not bf2admin.getConfig('pk_enabled'):
bf2admin.setConfig('pk_enabled', 1)
if not bf2admin.getConfig('sk_enabled'):
bf2admin.setConfig('sk_enabled', 1)

if not bf2admin.getConfig('pk_samples'):
bf2admin.setConfig('pk_samples', 12) # two minuites of samples
if not bf2admin.getConfig('pk_warnings'):
bf2admin.setConfig('pk_warnings', 3)
if not bf2admin.getConfig('pk_maxping'):
bf2admin.setConfig('pk_maxping', 1)
if not bf2admin.getConfig('sk_warnings'):
bf2admin.setConfig('sk_warnings', 3)

host.registerHandler('PlayerConnect', onPlayerConnect)
host.registerHandler('PlayerDisconnect', onPlayerDisconnect)
host.registerHandler('PlayerSpawn', onPlayerSpawn)
host.registerHandler('PlayerDeath', onPlayerSpawn)
host.registerGameStatusHandler(onGameStatusChanged)
enableTimers()

def enableTimers():
global ten_secs
global sixty_secs

if not ten_secs:
ten_secs = bf2.Timer(ten_seconds, 10, 1)
ten_secs.setRecurring(10)
if not sixty_secs:
sixty_secs = bf2.Timer(sixty_seconds, 60, 1)
sixty_secs.setRecurring(60)

def ten_seconds(data):
# ping kick
enableTimers()

def sixty_seconds(data):
enableTimers()
for tp in bf2.playerManager.getPlayers():
if bf2admin.getConfig('pk_enabled') and tp.actuallyPlaying:
if tp.getPing() > bf2admin.getConfig('pk_maxping'):
if tp.pingWarnings < bf2admin.getConfig('pk_warnings'):
tp.pingWarnings += 1
tp.sendMessage('BF2Admin: WARNING ' + str(tp.pingWarnings) + '/' + str(bf2admin.getConfig('pk_warnings')) +'! YOUR PING IS TOO HIGH! YOU WILL BE REMOVED IF IT DOES NOT FALL BELOW ' + str(bf2admin.getConfig('pk_maxping')) + '!')
else:
host.rcon_invoke('game.sayAll "BF2Admin: ' + tp.getName() + ' was kicked due to high ping!')
host.rcon_invoke('admin.kickPlayer "' + tp.getName() + '"')
else:
tp.pingWarnings = 0

if bf2admin.getConfig('sk_enabled') and tp.actuallyPlaying:
if not tp.isCommander() and tp.getSquadId() == 0:
if tp.squadWarnings < bf2admin.getConfig('sk_warnings'):
tp.squadWarnings += 1
tp.sendMessage('BF2Admin: WARNING ' + str(tp.squadWarnings) + '/' + str(bf2admin.getConfig('sk_warnings')) +'! JOIN OR CREATE A SQUAD OR YOU WILL BE KICKED!')
else:
host.rcon_invoke('game.sayAll "BF2Admin: ' + tp.getName() + ' was kicked for not joining a squad!')
host.rcon_invoke('admin.kickPlayer "' + tp.getName() + '"')

def onPlayerSpawn(p, vehicle):
enableTimers()
p.actuallyPlaying = 1

def onPlayerDeath(p, vehicle):
p.actuallyPlaying = 1

def onPlayerConnect(player):
enableTimers()
resetPlayer(player)

def onPlayerDisconnect(player):
enableTimers()
resetPlayer(player)

def onGameStatusChanged(status):
gamestatus = status

if gamestatus == bf2.GameStatus.EndGame:
for tp in bf2.playerManager.getPlayers():
tp.actuallyPlaying = 0

except Exception, detail:
print 'Error! ' + detail
</pre>

File: users.cfg

This file should be placed in the ./admin/ directory in the main BF2 directory.

<pre>
# users.cfg # Administrator configuration file # users.cfg format # Note: playername is purly so the maintainer can tell who a line is for # # profileID "playername" "permissions" "reserved" "reserved" // Comment 44773626 "FSR|Danni" "abcdefghijklmnopqrstuvwxyz1234567890" "" "" // Main Admin
</pre>

Scripts:RconCfg

2018-06-22T15:27:22Z

Pireax: Created page with "__TOC__ == Introduction == Here's a script that adds an rcon command called 'cfg'. It is intended for server admins that want to execute several commands at once. For exampl..."

__TOC__

== Introduction ==

Here's a script that adds an rcon command called 'cfg'. It is intended for server admins that want to execute several commands at once. For example to easily change server settings for switching between public/match-settings. The script supports unlimited number of config-files.

== Installation ==

# Place <code>cfg.py</code> in the <code>BF2 Server Directory/admin/standard_admin/</code> directory.
# Add a line in the <code>___init___.py</code> file in the same directory that says <code>import cfg</code>.
# Make a directory called <code>cfg</code> in the <code>BF2 Server Directory/admin/</code> directory.
# Place your configs there, with the file-extension <code>.cfg</code>, containing one command per line.
# Restart server, login through rcon and type <code>rcon cfg <config name without .cfg></code>

For example: <code>rcon cfg restart</code> (to execute <code>BF2 Server Directory/admin/cfg/restart.cfg</code>.)

== The Code ==

As you might see most of the script is copied from default.py

<s>[http://truppo.mine.nu/truppo/cfg.py Download link for the script]</s>

== Updates ==

2005-08-03: First version posted

Scripts:RconMap

2018-06-22T15:27:01Z

Pireax: Created page with "__TOC__ == Introduction == Here's a script that adds an rcon command called 'map'. I'm not really a programmer so some of this can probably made in a better way but I'm just..."

__TOC__

== Introduction ==

Here's a script that adds an rcon command called 'map'. I'm not really a programmer so some of this can probably made in a better way but I'm just glad I got it working. Wouldn't mind any tips on improvement though =).

== Installation ==

1. Place map.py in the <code>BF2 Server Directory/admin/standard_admin/</code> directory

2. Add a line in the <code>___init___.py</code> file in the same directory that says <code>import map</code>

3. Restart server, login through rcon and type 'rcon map' for instructions

== Update ==

Version 0.2 doesn't clear the maplist any longer, it will instead search through your current maplist and append the map requested if it's not already in the rotation.

== The Code ==

As you might see the script is easily customisable so you can add your own aliases if needed.

[http://biomass.baconmen.net/map.py Download link for the script]

<pre>
# --------------------------------------
# Battlefield 2 - rcon command "map" 0.2
# --------------------------------------

# Version history:
#
# 0.2 Made maplist check so that you won't loose your maplist when the map is changed
# through the command.
#
# Unnamed First release. Basic map functionality.
#

# Written by biomass from Clan BaconMen (http://www.baconmen.net)
# Thanks to Truppo for the inital inspiration =)
# Lots of kudos to the people behind the BF2 Python Wiki.
#
# This scripts let you change maps through rcon without having to deal
# with a maplist manually. It also allows you to use shorter names for
# the different maps and currently if a map isn't in your maplist it
# will be appended and added to that rotation..
#
# HOWTO Install:
#
# 1. Place map.py in the <BF2 Server Directory/admin/standard_admin/> directory
# 2. Add a line in the ___init___.py file in the same directory that says
# import map
# 3. Restart server, login through rcon and type 'rcon map' for instructions
#
# That's it =)

import default
import new
import string
import host
import re

def rcmd_map(self, ctx, cmd):
shortmaps = {
'dalian': 'dalian_plant',
'plant': 'dalian_plant',
'dalian_plant': 'dalian_plant',
'daqing': 'daqing_oilfields',
'oilfields': 'daqing_oilfields',
'daqing_oilfields': 'daqing_oilfields',
'dragon': 'dragon_valley',
'valley': 'dragon_valley',
'dragon_valley': 'dragon_valley',
'fushe': 'fushe_pass',
'pass': 'fushe_pass',
'fushe_pass': 'fushe_pass',
'gulf': 'gulf_of_oman',
'oman': 'gulf_of_oman',
'gulf_of_oman': 'gulf_of_oman',
'kubra': 'kubra_dam',
'dam': 'kubra_dam',
'kubra_dam': 'kubra_dam',
'mashtuur': 'mashtuur_city',
'city': 'mashtuur_city',
'mashtuur_city': 'mashtuur_city',
'clean': 'operation_clean_sweep',
'sweep': 'operation_clean_sweep',
'operation': 'operation_clean_sweep',
'operation_clean_sweep': 'operation_clean_sweep',
'sharqi': 'sharqi_peninsula',
'peninsula': 'sharqi_peninsula',
'sharqi_peninsula': 'sharqi_peninsula',
'strike': 'strike_at_karkand',
'karkand': 'strike_at_karkand',
'strike_at_karkand': 'strike_at_karkand',
'songhua': 'songhua_stalemate',
'stalemate': 'songhua_stalemate',
'songhua_stalemate': 'songhua_stalemate',
'zatar': 'zatar_wetlands',
'wetlands': 'zatar_wetlands',
'zatar_wetlands': 'zatar_wetlands'
}
maperror = 0
mapinmaplist = 0
if cmd != "":
mapvars = cmd.split()
if len(mapvars) == 1:
if mapvars[0] == 'list':
maperror = 2
for m in shortmaps:
ctx.write(m + ', ')
elif shortmaps.has_key(mapvars[0]):
ctx.write('Please specify playersize...\n')
maperror = 1
else:
ctx.write('Unknown map...\n')
maperror = 1
if len(mapvars) >= 2:
if not shortmaps.has_key(mapvars[0]):
maperror = 1
ctx.write('Unknown map...\n')
try:
if int(mapvars[1]) not in [16,32,64]:
maperror = 1
ctx.write('Unknown playersize...\n')
except ValueError:
ctx.write('Unknown playersize...\n')
maperror = 1
else:
maperror = 1
if int(maperror) == 1:
ctx.write('\n')
ctx.write('map: USAGE: rcon map (partial mapword or complete mapname) (playersize 16/32/64)\n')
ctx.write('map: USAGE: rcon map list - prints a list of valid aliases/names\n')
elif int(maperror) == 2:
ctx.write('end of maplist\n')
else:
maplist = serverConfig("maplist.list")
pattern = re.compile('^\d+:\s\"(.*?)\"\sgpm_cq\s(\d{2})$', re.MULTILINE)
result = []
for maplist in pattern.findall(maplist):
result.append((maplist[0].lower(),maplist[1]))
for mapavailable in result:
if str(mapavailable[0]) == shortmaps[mapvars[0]]:
if int(mapavailable[1]) == int(mapvars[1]):
mapinmaplist = 1
if mapinmaplist != 0:
host.rcon_invoke("admin.nextLevel " + str(result.index((shortmaps[mapvars[0]],mapvars[1]))))
host.rcon_invoke("admin.runNextLevel")
ctx.write('Map in maplist - Changing map to ' + shortmaps[mapvars[0]] + ' - ' + mapvars[1] + ' players\n')
else:
ctx.write('Changing map to ' + shortmaps[mapvars[0]] + ' - ' + mapvars[1] + ' players\n')
host.rcon_invoke('mapList.append ' + shortmaps[mapvars[0]] + ' gpm_cq ' + mapvars[1])
host.rcon_invoke("game.sayAll \"Changing map to " + shortmaps[mapvars[0]] + " - " + mapvars[1] + " players\"")
host.rcon_invoke("admin.nextLevel " + str(len(result)))
host.rcon_invoke("admin.runNextLevel")

newMethod = new.instancemethod(rcmd_map, default.server, default.AdminServer)

default.AdminServer.rcmd_map = newMethod

default.server.rcon_cmds['map'] = default.AdminServer.rcmd_map

def serverConfig(variableName):
return host.rcon_invoke(variableName).strip()
</pre>

= Updates =

2005-Jul-30: Version 0.2 posted

earlier date: First version posted

Scripts:BadWords

2018-06-22T15:26:45Z

Pireax: Created page with "== Introduction == I own a cybercafe / game center where the most popular game is BF2. Most of our customers are teenagers, but we get quite a few younger and older gamers,..."

== Introduction ==

I own a cybercafe / game center where the most popular game is BF2. Most of our customers are teenagers, but we get quite a few younger and older gamers, too. The parents of the younger ones are naturally concerned about some of the language used in chat messages in online games; even quite a few older gamers find some of racist and related language used by some online gamers to be offensive. To help keep our servers feeling friendly to everyone, I wrote this script.

The basic idea is that when the server starts, the script reads a configuration file that contains words you want to prohibit players from using in their names and chat messages; the format of the file is just a list of "bad" words, one per line. Every time a player connects, the script scans the players name for the presence of any of bad words; every time a player sends a chat message, the chat message is similarly scanned. If the script finds any of the bad words in a name or chat message, the player is immediately kicked using the PunkBuster kick facility (so that they can be given a meaningful reason why they were kicked), other players are notified about what happened to them, and a log message is printed.

The name of the file containing the list of bad words, and the length of time they will be kicked for, are set in variables at the beginning of the script. NOTE: be careful with your choices of words for the bad words file--the script is written to catch these words occuring in any kind of substring in chat messages and names, so if you're not careful you can find your server is kicking people who are using perfectly innocent names.

It's probably also a good idea to warn people if you're using software like this on your server: use a script like [[Scripts:Automatic_Announcements|this]] or [[Scripts:TXT_File_base_Automatic_Announcements|this]], for example, to tell people they will be automatically kicked if they use inappropriate language.

To install the script, just <code>import</code> it from one of the main BF2 scripts, such as <code>Battlefield 2 Server/admin/default.py</code>

== Code ==

<pre>
'''badWords: Module to kick players for using "bad" words.

Version 0.01, 2005 August 3, Forrest Thiessen'''

#Copyright (c) 2005 Cyberscape Enterprises, Inc., www.cyberscapearena.com
#
#Permission is hereby granted, free of charge, to any person obtaining a
#copy of this software and associated documentation files (the "Software"),
#to deal in the Software without restriction, including without limitation
#the rights to use, copy, modify, merge, publish, distribute, sublicense,
#and/or sell copies of the Software, and to permit persons to whom the
#Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included
#in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
#OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
#FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
#DEALINGS IN THE SOFTWARE.
#
#Battlefield 2 is a trademark of Digital Illusions CE AB. Electronic Arts,
#EA, EA GAMES and the EA GAMES logo are trademarks or registered trademarks
#of Electronic Arts Inc. in the U.S. and/or other countries. EA GAMES(tm) is
#an Electronic Arts(tm) brand.

import host
import bf2
import time

badWordsFileName = "admin/BadWords.con" # File containing list of bad words, one per line
kickTime = 10 # Default kick time in seconds

badWords = []

# Open the file, read the bad word list, and register handlers
try:
badWordsFile = open(badWordsFileName, 'r')
# Read the file into a list, each element being one bad word
badWords = [word.strip() for word in badWordsFile.readlines()]

# Register handlers to receive chat messages and player connections
host.registerHandler('ChatMessage', onChatMessage, 1)
host.registerHandler('PlayerConnect', onPlayerConnect, 1)

print 'BadWords: BadWords module initialized with', len(badWords), 'words.'

except IOError:
print "BadWords: Couldn't open bad words file", fileName

# As players connect to the server, check if their names contain any of
# the bad words, and kick them if they do.
def onPlayerConnect(playerObject):
global badWords, kickTime

name = playerObject.getName()

for word in badWords:
if name.find(word) == -1: continue

host.rcon_invoke('game.sayall "Player %s kicked for having an inappropriate name"'
% playerName)
host.rcon_invoke('pb_sv_kick "%s" %i "Inappropriate name"'
% (playerName, kickTime))
print ( 'BadWords: Player %s kicked for having inappropriate name at %s'
% (playerName, time.strftime("%a %d-%b-%Y %H:%M")) )

break

# Whenever a chat message is sent on any channel, check it for bad words; if
# there are any, kick the player who sent the message.
def onChatMessage(playerID, msgText, channel, flags):
global badWords, kickTime

if playerID < 0: return # The server operator can be a potty-mouth if he wants

for word in badWords:
if msgText.find(word) == -1: continue

playerName = bf2.playerManager.getPlayerByIndex(playerID).getName()
host.rcon_invoke('game.sayall "Player %s kicked for using inappropriate language"'
% playerName)
host.rcon_invoke('pb_sv_kick "%s" %i "Using inappropriate language"'
% (playerName, kickTime))
print ( 'BadWords: Player %s kicked for saying "%s" at %s'
% (playerName, word, time.strftime("%a %d-%b-%Y %H:%M")) )

break
</pre>

== Discussion ==

There are lots of variations possible on this script: you could ban players instead of kicking them; you could warn them three times first, then kick them; you could save their profile ID or CD key for future action if they repeat their offense, etc. This script was written to be both simple and useful, but you could also extend the basic concept shown here to use regular expressions (to avoid kicking player "gilbert_grape", for example, if the word "rape" was on your bad words list), at the expense of complicating both the script and the word list.

It should also be pointed out that PunkBuster has a [http://www.evenbalance.com/publications/bf2-ad/index.htm#badname similar facility] for kicking players based on bad words in their player names; I've found it to be a pain to configure, however, and it does nothing for chat messages, which is where the larger problem is. . . plus it leaves a lot of the "bad" words on your server console screen every time it loads its word list (not good for tours).

Scripts:AutoShutdown

2018-06-22T15:26:22Z

Pireax: Created page with "== Introduction == I got tired of manually warning my users before shutdown, so I wrote this to automate the task for me. It warns players at intervals before shutting down...."

== Introduction ==

I got tired of manually warning my users before shutdown, so I wrote this to automate the task for me. It warns players at intervals before shutting down. The warnings occur at 60, 30, 15, 10, 5, 4, 3, 2, 1 minutes before shutdown. This script needs serious work from someone who actually knows Python. I post it here in the hopes that people will improve on it (perhaps by moving the configuration variables into an easily-modified external file?)

== Usage ==

Copy/Paste this script into a text file. Save it as <code>autoshutdown.py</code> in your <code>standard_admin</code> folder. Modify your <code>__init__.py</code> file to import and execute it.

== Code ==

<pre>
import datetime
import time
import host
import bf2
from bf2 import g_debug

shutdownTime = "01:00" #use 24-hour time. Format should be "hh:mm"
quitOrPause = "pause" #options are "pause" (pause game but leave server running) or "quit" (kill the server)

shutdownTimer = None
def init():
global shutdownTime, shutdownTimer
shutdownHour = int(time.strftime("%H",time.strptime(shutdownTime,"%H:%M")))
shutdownMinute = int(time.strftime("%M",time.strptime(shutdownTime,"%H:%M")))
today = datetime.datetime.now()
shutdownTime = datetime.datetime(today.year, today.month, today.day, shutdownHour, shutdownMinute)
if shutdownHour < today.hour:
shutdownTime = datetime.datetime(today.year, today.month, today.day + 1, shutdownHour, shutdownMinute)
shutdownTimer = bf2.Timer(checktime, 1, 1)
shutdownTimer.setRecurring(60)
host.rcon_invoke('echo "autoshutdown.py loaded"')

def checktime(whatever):
global shutdownTime
global quitOrPause

timeTilShutdown = shutdownTime - datetime.datetime.now()
minsTilShutdown = int((timeTilShutdown.seconds / 60))
host.rcon_invoke('echo "Debug: ' + str(minsTilShutdown) + ' minutes to shutdown."')
msg = None
if minsTilShutdown == 60:
msg = 'ADMIN: SERVER SHUTDOWN IN 60 MINUTES'
if minsTilShutdown == 30:
msg = 'ADMIN: SERVER SHUTDOWN IN 30 MINUTES'
if minsTilShutdown == 15:
msg = 'ADMIN: SERVER SHUTDOWN IN 15 MINUTES'
if minsTilShutdown == 10:
msg = 'ADMIN: SERVER SHUTDOWN IN 10 MINUTES'
if minsTilShutdown == 5:
msg = 'ADMIN: SERVER SHUTDOWN IN 5 MINUTES'
if 0 < minsTilShutdown < 5:
msg = 'ADMIN: SERVER SHUTDOWN IN ' + str(minsTilShutdown) + ' MINUTE(S)'

if msg != None:
adminMessage(msg)

if minsTilShutdown <= 0:
msg = 'ADMIN: SERVER WILL SHUTDOWN *NOW*'
adminMessage(msg)
timestamp = time.strftime("%Y-%m-%d, %I:%M:%S %p",time.localtime())
if quitOrPause == "quit":
if g_debug: print timestamp + ' -- Server halted.'
host.rcon_invoke('quit')
if quitOrPause == "pause":
host.rcon_invoke('echo "' + timestamp + ' -- Game paused."')
if g_debug: print timestamp + ' -- Game paused.'
host.rcon_invoke('gamelogic.togglepause')

def adminMessage(msg):
for i in range(1,26):
host.rcon_invoke('game.sayAll "' + msg + '"')
host.rcon_invoke('echo "' + msg + '"')
if g_debug: print msg
</pre>

: Greeze 07:50, 1 Jul 2005 (MDT)
: Greeze 04:13, 2 Jul 2005 (MDT) --

::* Removed game status check (was creating multiple timer instances everytime the map changed); moved timer creation to init()
::* Slightly reordered message-sends in the checkTime function

Scripts:Automatic Announcements

2018-06-22T15:25:55Z

Pireax: Created page with "Ever want to have an some announcement that is automatically periodically displayed on all players' screens? Here's how to do it: <pre> import bf2 import bf2.Timer import..."

Ever want to have an some announcement that is automatically periodically displayed on all players' screens? Here's how to do it:

<pre>
import bf2
import bf2.Timer
import host

interval = 30 # Number of seconds between announcements
message = "Your announcement message goes here"

def onTimer(data):
global message
host.rcon_invoke('game.sayall "%s"' % message)

timer = bf2.Timer(onTimer, interval, 1)
timer.setRecurring(interval)
</pre>

To work, this script needs to be a module (in it's own file--for example, "<code>simpleAnnounce.py</code>") which is imported by one of the main BF2 modules or packages (bf2, the Admin module, or the bf2 mod); you can import it from any of these, but because of it's function, it probably makes the most sense to import it from the admin module.

To do this, put simpleAnnounce.py into the directory <code>Battlefield 2 Server/Admin/standard_admin</code>; then, in that same folder, edit the file <code>__init__.py</code> and add the line

<pre> import simpleAnnounce </pre>

(it doesn't matter where you put this line inside <code>__init__.py</code>).

When the [[Admin_Module|Admin Module]] is initialized, it imports the <code>standard_admin</code> package, which, because of the change you made, will now also import your <code>simpleAnnounce</code> module. When a module is first imported the code in it is run, so <code>simpleAnnounce</code> will create a [[Object_Reference#bf2.Timer|bf2.Timer]] object set to fire a [[Event_Reference#Timer_Events|TimerEvent]] every <code>interval</code> seconds, with a callback to the <code>onTimer</code> method. When <code>onTimer</code> gets called every <code>interval</code> seconds, it uses the <code>game.sayall</code> server command to send your message to all players.

This script is very basic--it should be easy to extend it to, for example, rotate one by one through a set of different messages, to read the messages it displays from a configuration file, etc.

--Woody

Scripts:dc ass

2018-06-22T15:25:24Z

Pireax: Created page with "__TOC__ == Introduction == The DontCamp Administrative Support System is a completely server-side, python based admin system for Battlefield 2 that uses in-game chat comman..."

__TOC__

== Introduction ==

The DontCamp Administrative Support System is a completely server-side, python based admin system for Battlefield 2 that uses in-game chat commands and cd keyhash authentication to provide easy to use and powerful administrative functions.

Some of the better features of dc_ass are:

* kicking by playername, partial playername, or player ID
* single command multiple kick options against clan tags or team number (only used for evil, I know)
* variable userlevels via a PB style power points system
* allows the general public to vote kick someone without the annoying prompts
* completely an in-game and fast admin system so you can spend your time playing

== The code ==

=== dc_ass.py ===

<pre>
"""
DontCamp.com Administrative Support System v. 1.2.1
written by: butter@dontcamp.com

Changelog:
1.2 beta:
* added support for multiple arguments in a chat command
* no longer spews so much to the screen when someone is kicked
1.1.1 beta:
* playernames with prefixs can now issue commands
1.1 beta:
* added userlevels via a kick points system a la PB power users
* added general public vote kicking
* using keyhash rather than PB GUID for auth
* moved to more OO codebase
* extensions can now act on anything in the dc_ass object

Acknowledgements:
Thanks to dst@dontcamp.com for significant coding contributions.
Thanks to superwabbit@dontcamp.com for his conceptual contributions.
Thanks to my brother for helping me with fundamental coding concepts.
Thanks to the guy that was willing to sell me a T40 ThinkPad on eBay for
that insanely low price!
Dear God, thanks be to O'Reilly!
And a REALLY BIG thanks to Kevin Lockitt of blackbagops.com. This software
is clearly a big stinkin' rip off of BFSM, a program that did as much
as anything to make DontCamp.com the successful gaming community that
it is.

Purpose:
To provide an in-game chat based admin system similar to Kevin Lockitt's
Battlefield Server Manager while also providing a kick vote system
similar to PunkBuster's Poweruser system.

Requirements:
1. dc_debug.py - a common debugging function for all DontCamp.com BF2
python level tools
2. dc_ass_extensions.py - this file is currently required to exist but
can be empty. See dc_ass_extensions Instructions.
3. dc_ass_cmds.ini - the configuration file for all in-game admin commands
4. power.dat - a list of your admins' power levels and keyhashs

Known issues:
1. writeToLogfile() is not currently tested or up-to-date and is therefore
disabled.
2. In general be very careful what you code in an extension. The BF2
server may lag or crash when running poorly written extensions.
3. dc_ass currently requires punkbuster to be enabled.
4. There is almost no sanity checking for poorly configured INI files.
5. Non permanent bans are not maintained between server restarts.

Setup:
1. Drop dc_ass.py and dc_debug.py into the admin/standard_admin directory
of your BF2 installation.
2. Edit admin/standard_admin/__init__.py file to include these lines:

import dc_ass
dc_ass.init()

3. Create an empty dc_ass_extensions.py file or populate it as per the
dc_ass_extensions instructions below.
4. Create a power.dat file as per the instructions below.
5. Create / edit a dc_ass_cmds.ini file as per the instructions below.

power.dat Instructions:
This file is simply a space delimited file with two values on each line
that must exist in the admin/standard_admin directory. The first value is
the power level assignment and the second value is the keyhash.

Currently dc_ass is lacking some flexibily in that 10 kick points always
causes a player to be kicked. Keep that in mind when assigning power
levels. The power level must be a positive integer but can otherwise be
whatever you like.

The keyhash for a user is a 32 digit hexidecimal number that be found when
executing admin.listplayers in the console. I have written a dc_ass
extensions that prints the keyhash for a user while in-game and I will like
make that extensions available in the future. Please note that BF2
keyhashes are NOT the same thing as PB GUID's.

An example power.dat file:

10 352a507c78da1dea6dd42a5867d3c2cc
4 2365c8ef755723efc10b425fffb65ebe

This examples shows that the player with the keyhash:
352a507c78da1dea6dd42a5867d3c2cc can apply 10 kick points to each player
and that the player with the keyhash: 2365c8ef755723efc10b425fffb65ebe can
apply 4 kick points to each player.

Since 10 kick points kicks a user, we can assume that any admin with a
kick power of 10 is a full admin and therefore they can run "admin"
commands. See the section on the dc_ass_cmds.ini file for more info.

dc_ass_cmds.ini Instructions:
This file follows standard INI file formatting. Each section name is the
name of a command that can be run from in-game text chat. Each section
must have a "type" option. Supported types are:
kick - a simple kick
ban - a permanent ban (or possibly temporary)
rcon - user defined rcon command execution
extension - user defined python function execution

Depending on the type, different options are required. Each type supports
the "admin" option. When admin = 1, the user must have a kick power of 10
to execute that command. When admin = 0, any user on your BF2 server is
allowed to execute that command. The admin option is optional and defaults
to 1.

(* = required)
Type: kick
Options:
*reason = (a non-delimited string contained the reason for this kick)
length = (an integer representing how many minutes before the
the offender will be allowed back into the game. If this option is
missing, the default value will be 2.)
Type: ban
Options:
*reason = (same as above)
length = (same as above) (see known issue #5)

Type: rcon
Options:
*command = (a non-delimited string contained the rcon command you want
to issue)

Type: extension
Options:
*function = (the name of the function in dc_ass_extensions.py you want
this command to run WITHOUT any (). See dc_ass_extensions
Instructions.)

An example dc_ass_cmds.ini file might look like this:

[kfms]
type = kick
reason = for firing from a vehicle in/into an uncapturable spawn
length = 5

[brsc]
type = ban
reason = for a racist or slanderous comment

[restart]
type = rcon
command = admin.restartmap

[slap]
type = extension
function = slapPlayer

[nextmap]
type = extension
function = sayNextMap
admin = 0

NOTE: Changes made to the dc_ass_cmds.ini file are in effect immediately
and do not require a server restart.

dc_ass_extensions.py Instructions:
The extensions provide a means to do more complex actions that cannot be
achieved through a simple rcon command. This file works similarly to other
python files inside the BF2 environment. It's simply a list of functions
as well as the proper imports to provide the facility the functions
require.

NOTE: Each function that is run as an extension must accept one and only
one parameter. That parameter will be the dc_ass admin object most noteably
containing these properties:

victim_id - a list of all integers of the victim IDs found via the
parameter for this the command executed

victim_tracker - a dictionary of all the people currently being tracked
by dc_ass (in other words, people that have had kick points issued
against them). This is a multidemensional dictionary where the top
level key is the player_id / slot number and value is another
dictionary where the key is the keyhash of the issuer of the points and
the value is the number of points issued by said issuer.

issuer - an integer representing the player_id of the person that executed
the current command.

keyhash - a string that is the hexidecimal keyhash of the person that
executed the current command.

See http://dontcamp.com/code/ for an example dc_ass_extenions.py file.

Note: Changes made to the dc_ass_extensions.py file are in effect
immediately and do not require a server restart.

How to use all this once you've got it setup:
All commands are issued with in-game chat, NOT console commands. To my
knowledge, these commands should work in any chat mode. Each command MUST
be prefixed with an ! and optionally suffixed with a space followed by a
case insensitive playername, partial playername, or a . followed by a
player number. Additionally, you may prefex an @ in front of a case
insensitive string to execute an action against all players containing
that string in their playername. You may also use a % followed by a team
number to execute a command against an entire team.

Using our previous example INI file and given that the server has two
players on it: Butter (in slot 0) and MuttDog (in slot 1) here's how the
following commands would react...

!kfms
[ Whenever no parameter for a victim is given, dc_ass will
assume the player ID of the admin issuing the command. In this
case the admin will be kicked for 5 minutes for firing into
a main spawn. ]

!kfms .0
[ This will kick Butter for 5 minutes for firing into a main spawn
because butter is player number 0 / in slot 0. ]

!kfms butter
[ This will also kick Butter because butter matches Butter in our
case insensitive string comparison. ]

!kfms ter
[ This will also kick Butter because ter is a string match in
Butter's name and ONLY in Butter's name. ]

!kfms utt
[ This will kick no one but print a global message in green at the
top left of the screen that utt is ambiguous. ]

!kfms dst
[ This will kick no one and print a global message saying "Could
not find ID for dst". ]

!kfms @t
[ This will kick both dst and butter as they both have a t in their
their playername. ]

!kfms @T
[ This will still kick both dst and butter because our text search
is case insensitive. ]

!kfms %2
[ This will kick everyone on team 2. ]
"""

import bf2
import host
import re
import ConfigParser
import time
from dc_debug import decho
from dc_debug import showLevel
import dc_ass_extensions

class ass:
# some init vars
victim_tracker = {}
admin_level = 10
default_weight = 2
kick_threshold = 10

"""
_getPlayerList(): returns a dictionary of players currently playing
where the key is their player player_id/index and the value is list
containing their playername, IP, outbound port, and CD-key hash.
Thanks to Woody for doing all the hard work on this one.
"""
def _getPlayerList(self):
rawData = host.rcon_invoke( 'admin.listplayers' )
# this patern is for line 0 of the output for each player
# pattern1 = re.compile(r'''^Id:\ +(\d+)\ -\ (\S+)\ is\ remote\ ip:\ (\d+\.\d+\.\d+\.\d+):(\d+)''', re.VERBOSE)
pattern1 = re.compile(r'''^Id:\ +(\d+)\ -\ (.*?)\ is\ remote\ ip:\ (\d+\.\d+\.\d+\.\d+):(\d+)''', re.VERBOSE)
# this patern is for line 1 of the output for each player
pattern2 = re.compile(r'''(?:.*hash:\ (\w{32}))?''', re.VERBOSE)
players = {}

i = 0
for line in rawData.split("\n"):
# if we're looking at a "line 0"
if i == 0:
matches = pattern1.findall(line)
if len(matches) != 0:
p_id = int(matches[0][0])
players[p_id] = []
players[p_id].append(matches[0][1])
players[p_id].append(matches[0][2])
players[p_id].append(matches[0][3])

# if we're looking at a "line 1"
elif i == 1:
matches = pattern2.findall(line)
players[p_id].append(matches[0])

# flop the value of the iter
i ^= 1

return players

"""
_getWeight(): finds the admin level of the user at index
returns true on success, false on failure (the true case being that a user is found at index)
assigns string self.keyhash as the keyhash of the user at index
assigns int self.user_weight as the admin level of the user at index
"""
def _getWeight(self, index):
return_value = False
players = self._getPlayerList()
self.user_weight = self.default_weight

if players.has_key(index):
return_value = True
self.keyhash = players[index][3]
# assigns the default weight in case this user is not found in the pbpower.dat file
decho( "dc_ass: Attempting to authenticate keyhash: %s" % self.keyhash, 5 )

# just in case there is no pbpower.dat file
try:
for line in open('admin/standard_admin/power.dat', 'r'):
if self.keyhash == line.split(' ')[1].strip():
self.user_weight = int(line.split(' ')[0].strip())
decho( "dc_ass: %s is level %d in power.dat!" % (self.keyhash, self.user_weight), 5 )
break

except IOError:
decho( "dc_ass: unable to open pb/pbpower.dat file", 5 )

return return_value

"""
_getVictimId(): finds all victims from the in-game chat command parameter
returns true on success and false on failure (the failure case is not being able to determine with certainly which victims the command is for)
assigns list self.victim_id
"""
def _getVictimId(self, parameter):
# returns true/false on success/failure and assigns self.victim_id if possible
# self.victim_id is a list of all victims found
# sorry for the silly parameter name, but it does make sense in this case.

self.victim_id = []
result = False # default value for result
decho("dc_ass: Attempting to find victim ID...", 5)

# if the parameter is the player number
if parameter[0:1] == ".":
id = int(parameter[1:])

for p in bf2.playerManager.getPlayers():
if p.index == id:
self.victim_id = [id]
decho( "dc_ass: parameter was an int, and id = %d" % self.victim_id[0], 5 )
result = True
break

if not result:
decho( "dc_ass: (ERROR) no player found with ID: %d" % id, 1 )

# if the parameter is a wildcard / clantag
elif parameter[0:1] == "@":
decho( "dc_ass: finding ALL matching players with parameter...", 5 )
decho( "dc_ass: parameter was NOT an int", 5 )

# for all players connected...
for p in bf2.playerManager.getPlayers():
decho( "dc_ass: checking player: %s" % p.getName(), 5 )
# if we find a name that loosely matches...
if p.getName().lower().find( parameter[1:].lower() ) != -1:
decho( "dc_ass: %s loosely matches %s" % ( parameter[1:], p.getName() ), 5 )
self.victim_id.append(p.index)
result = True

if result:
decho( "dc_ass: Victim ID(s) found @ %r" % self.victim_id, 5 )
else:
decho( "dc_ass: (ERROR) no players found with %s in their name" % parameter[1:], 1 )

# if the parameter is a team number
elif parameter[0:1] == "%":
decho( "dc_ass: finding ALL matching players on team matching paramenter...", 5 )

# for all players connected...
for p in bf2.playerManager.getPlayers():
decho( "dc_ass: checking player: %s" % p.getName(), 5 )
# if we find a player on the team supplied
if p.getTeam() == int(parameter[1:]):
decho( "dc_ass: %s is on team %s" % ( p.getName(), p.getTeam() ), 5 )
self.victim_id.append(p.index)
result = True

if result:
decho( "dc_ass: Victim ID(s) found @ %r" % self.victim_id, 5 )
else:
decho( "dc_ass: (ERROR) there seems to be no one on team %s" % parameter[1:], 1 )

# if the parameter is a playername or partial playername
else:
id = -1
decho("dc_ass: parameter was NOT an int", 5)
# for all players connected...
for p in bf2.playerManager.getPlayers():
decho( "dc_ass: checking player: %s" % p.getName(), 5 )
# if we find a name that loosely matches...
if p.getName().lower().find( parameter.lower() ) != -1:
decho( "dc_ass: %s loosely matches %s" % ( parameter, p.getName() ), 5 )
# if this is the first victim we've found...
if id == -1:
decho("dc_ass: found %s in %s" % ( parameter, p.getName() ), 5)
id = [int(p.index)]
result = True
# if we've gotten another possible match...
else:
result = False
break

if result:
self.victim_id = id
decho( "dc_ass: Victim ID found @ %d" % self.victim_id[0], 5 )
else:
decho( "dc_ass: %s is ambiguous." % parameter, 1 )

return result

"""
def writeLogFile(self, victim_id, admin_id, type, reason, length):
v = bf2.PlayerManager.Player(victim_id)
a = bf2.PlayerManager.Player(admin_id)
decho("\"%s\",%s,%d,%s,%d,%s,%s,%d,%s\n" % (v.getName(), v.getAddress(), v.getProfileId(), a.getName(), int(time.time()), bf2.gameLogic.getMapName(), type, reason, length * 60), 5)

fo = open('admin/standard_admin/adminlog.csv', 'a')
# v.name, v.ip, v.profileId, a.name, timestamp, map, type, length, reason
fo.write("\"%s\",%s,%d,%s,%d,%s,%s,%d,%s\n" % (v.getName(), v.getAddress(), v.getProfileId(), a.getName(), int(time.time()), bf2.gameLogic.getMapName(), type, reason, length * 60))
fo.close()
"""

"""
_stripPrefix(): removes context prefixes from a chati lines and returns the trimmed chat line
"""
def _stripPrefix(self, text):
text = text.replace( "HUD_TEXT_CHAT_TEAM", "" )
text = text.replace( "HUD_TEXT_CHAT_SQUAD", "" )
text = text.replace( "HUD_CHAT_DEADPREFIX", "" )
text = text.replace( "*\xA71DEAD\xA70*", "" )

return text.strip()

def addPoints(self):
# add entries in the victim_tracker foreach victim
for v_id in self.victim_id:
# check to see if we're already tracking the joker
if self.victim_tracker.has_key(v_id):
decho( "dc_ass: already tracking %d" % v_id, 5 )
# check to see if this admin has already applied their weight to the victim
if not self.victim_tracker[v_id].has_key(self.keyhash):
self.victim_tracker[v_id][self.keyhash] = self.user_weight
# added this conditional to make it a bit less noisy when someone is just kicked with one action
if self.user_weight < self.kick_threshold:
decho( "dc_ass: applied %d points from %s to player %d" % (self.user_weight, self.keyhash, v_id), 5 )
# this elif was really added to deal with an extension used at DontCamp.com but it makes sense to have anyway
elif self.user_weight == self.kick_threshold:
self.victim_tracker[v_id][self.keyhash] = self.user_weight
else:
decho( "dc_ass: %s has already applied their points to %s" % (bf2.PlayerManager.Player(self.issuer).getName(), bf2.PlayerManager.Player(v_id).getName()), 1 )
else:
self.victim_tracker[v_id] = {}
decho( "dc_ass: now tracking player: %d" % v_id, 5 )
self.victim_tracker[v_id][self.keyhash] = self.user_weight
decho( "dc_ass: applied %d points from %s to player %d" % (self.user_weight, self.keyhash, v_id), 5 )

def checkPoints(self):
for index, tracking in self.victim_tracker.iteritems():
# reset total_points for this victim
total_points = 0

# added up all the points being applied to this victim
for unused_key, points in tracking.iteritems():
total_points += points

if index in self.victim_id:
decho( "dc_ass: %s now has %d of %d kick points" % (bf2.PlayerManager.Player(index).getName(), total_points, self.kick_threshold), 1 )

if total_points >= self.kick_threshold:
self.reason += " - see dontcamp.com/forums for discussion"
# issue the kick command
decho( "dc_ass: Kicking player '%s' (%d) %s" % (bf2.PlayerManager.Player(index).getName(), index, self.reason), 1 )
unused = host.rcon_invoke('pb_sv_kick %d %d %s' % (index + 1, self.length, self.reason) )

# it might be helpful to create a new object to pass to extensions that
# has a reference to the admin object. In that new object, that I hope
# would only exist during the execution of a command, things like the
# issuer and keyhash properties could be assigned.
def onChatMessage(self, player_id, text, channel, flags):
self.issuer = player_id
# pull the potential prefix off the text line
text = self._stripPrefix(text)

# unless the first character is ! don't do anything
if text[0:1] == "!":
decho( "dc_ass: the first character of %s was !" % text, 5 )

# As BF2 playernames cannot contain spaces except what is printed
# between the prefix and the name, it is probably safe to assume
# that we don't need to accept spaces in playernames for this
# parameter. Therefore, I could use the space as a separator
# between the victim name and another command parameter, like
# a custom reason.

# grab the parts of the chatline I need with a REGEX
pattern = re.compile(r'!(\w*) ?(\S*) ?(.*)')
matches = pattern.findall(text)
command = matches[0][0]
# set an arguments property for future use or for extensions
self.arguments = matches[0][2]
decho( "dc_ass: command = %s" % command, 5 )

# in case the command doesn't require a victim parameter...
if matches[0][1] != "":
parameter = matches[0][1]
decho( "dc_ass: parameter = %s" % parameter, 5 )
else:
parameter = None
decho( "dc_ass: no parameter given", 5 )

try: # read in the commands INI file
self.config = ConfigParser.ConfigParser()
self.config.read('admin/standard_admin/dc_ass_cmds.ini')

# is this a defined command in the INI file
if command in self.config.sections():
decho( "dc_ass: Command found in INI file!", 5 )
# define/declare some vars for this admin event (I really wouldn't need to do this if I know how to check if a var is defined or even exists
type = ""
# these values will be members of the object because they may be needed in an extension
self.length = 2 # the default length for a kick
self.reason = ""
admin = 1 # this makes all commands default to requiring admin privs

# get all possible options
# I could add sanity checks in here for poorly formated lines in the INI file
for option in self.config.options(command):
if option == "type":
type = self.config.get(command, option).strip()
elif option == "reason":
self.reason = self.config.get(command, option).strip()
elif option == "length":
self.length = int(self.config.get(command, option))
elif option == "command":
rcon_string = self.config.get(command, option).strip()
elif option == "admin":
admin = int(self.config.get(command, option))
elif option == "function":
function = self.config.get(command, option).strip()

# make sure we have a type
if type == "":
decho( "dc_ass: (ERROR) No type value for %s in dc_ass_cmds.ini file!" % command, 1 )

# good, we're all set
else:
decho( "dc_ass: type: %s" % type, 5 )

# to get their keyhash and admin level
if self._getWeight(player_id):

# see if we can/need to get a victim ID to move forward
if ( parameter != None and self._getVictimId(parameter) ) or parameter == None:

# for non-perma bans, change type to kick_ban - this will be useful when we start to log this stuff
if type == "ban" and self.length != "":
decho( "dc_ass: Length value given for ban. Converting type to kick_ban.", 5 )
type = "kick_ban"

# if no parameter was given, make the command reflect on the issuer
if parameter == None:
decho( "dc_ass: No parameter given... assigning victim_id to issuer.", 5 )
self.victim_id = [player_id]

if ( admin and self.user_weight == self.admin_level ) or not admin:

# the main switch like section that gets the shit done (if only I had switches)
# Are reasons optional in these PB kicks/bans? If so, I guess I don't need to worry about sanity checking them

if type == "kick" or type == "kick_ban":
self.addPoints()
self.checkPoints()

elif type == "ban":
for v_id in self.victim_id:
decho( "dc_ass: Banning player '%s' (%d) %s" % (bf2.PlayerManager.Player(v_id).getName(), v_id, self.reason), 1 )
unused = host.rcon_invoke( 'pb_sv_ban %d %s' % (v_id + 1, self.reason) )

elif type == "rcon":
decho( "dc_ass: Running rcon command: %s" % rcon_string, 2 )
unused = host.rcon_invoke( rcon_string )

elif type == "extension":
reload( dc_ass_extensions )
if function in dc_ass_extensions.__dict__:
decho( "dc_ass: executing %s() extension" % function, 2 )
# send the entire object to the extensions
exec( "dc_ass_extensions.%s(%s)" % (function, "self") )
else:
decho( "dc_ass: %s() extension not found." % function, 2 )

else:
decho( "dc_ass: No such type: %s" % type, 1 )

else:
decho ( "dc_ass: User in slot %d is not authorized for the requested action" % player_id, 1 )

else:
decho( "dc_ass: Victim ID not findable given the parameter", 2 )

else:
decho( "dc_ass: ERROR failed to get keyhash for player: %d" % player_id, 1 )

else: # end of is command in INI file conditional
decho( "dc_ass: (ERROR) %s command not found!" % command, 1 )

except IOError:
print "dc_ass: (FATAL ERROR) could not open one or more required files: (admin_profile_ids.csv | dc_ass_cmds.ini)"

else: # a debug line just so I can see all the chat if I need to
decho( "dc_ass: player %d: %s" % (player_id, text), 5 )

def onPlayerDisconnect(self, p):
# if they disconnect, which might have happened if they were kicked, drop them from the tracker, if they're even in it
if self.victim_tracker.has_key(p.index):
del(self.victim_tracker[p.index])
decho( "dc_ass: player %d disconnected and no longer tracked" % p.index, 2 )

admin = ass()

def init():
decho('dc_ass: initializing DontCamp.com Admin Support System', 2)
host.registerHandler('ChatMessage', admin.onChatMessage, 1)
host.registerHandler('PlayerDisconnect', admin.onPlayerDisconnect, 1)
showLevel()
</pre>

The source is downloadable from [http://dontcamp.com/code/?file=dc_ass.py&release=1 here].

=== Change Log ===

==== 1.2 beta ====
* added support for multiple arguments in a chat command
* no longer spews so much to the screen when someone is kicked

==== 1.1.1 beta ====
* playernames with prefixs can now issue commands

==== 1.1 beta ====
* added userlevels via a kick points system a la PB power users
* added general public vote kicking
* using keyhash rather than PB GUID for auth * moved to more OO codebase
* extensions can now act on anything in the dc_ass object

=== dc_debug.py ===

dc_debug.py is required for nearly all DontCamp BF2 python code. It manages the debuging and logging output of our software.

<pre>
"""
DontCamp.com Common Debugging Function
written by: butter@dontcamp.com
Revision: $Revision: 1.11 $

Purpose:
To provide a central way for all DontCamp BF2 python code to output
debugging and informational text.

Setup: (defaults should work well)

1. Create a admin/standard_admin/dc_debug.level file and put the debug
level you want in the first character of the first line of said file.
Valid levels are 1-5.
2. Set log_to_file to either False or True if you want a seperate dc_debug
log file for all DontCamp BF2 python code debug output.
3. Set log_filename to whatever filename and path you like (relative to
your BF2 home directory). This is only necessary if log_to_file is set
to True.
4. Set log_to_stdout to either True or False if you want dc_debug to send
out its output to the python stdout interface. This is useful if you
are using BF2CC and want dc_debug's output in the pythonlog.txt file.
"""

import host
import time

try:
debug_level_fh = open('admin/standard_admin/dc_debug.level', 'r')
debug_level = int(debug_level_fh.read(1))
debug_level_fh.close()

except:
debug_level = 5

log_to_file = True
log_filename = 'dc_debug.log'
log_to_stdout = False

def decho(msg, level = 1):
# 1 = info w/ in-game feedback
# 2 = info
# 5 = debug

if debug_level > 0 and debug_level >= level:
string = time.strftime('%Y-%m-%d %H:%M:%S') + ' - ' + msg

if log_to_stdout:
print string

if log_to_file:
fh = open(log_filename, 'a')
fh.write(string + '\n')
fh.close()

if level == 1:
host.rcon_invoke('game.sayall "%s"' % msg)

def showLevel():
decho('dc_debug: The current debug level is %d' % debug_level, 2)
</pre>

The source is downloadable from [http://dontcamp.com/code/?file=dc_debug.py&release=1 here]

Scripts:Kicking for high ping

2018-06-22T15:25:02Z

Pireax: Created page with "__TOC__ = Introduction = There are many things that may influence the quality of a BF2 server. One of them is the ping of the players. Playing against a lot of players with..."

__TOC__

= Introduction =

There are many things that may influence the quality of a BF2 server. One of them is the ping of the players. Playing against a lot of players with very high ping is straight out frustrating. Therefore a lot of server-operators choose to kick players with high ping, and the best way to do it is of course to do it automatically.

With that in mind, we at [http://www.battlefield.no/ Battlefield.no] have developed a '''''ping kick''''' script that solves this problem on our servers. And hopefully it can be of use to the rest of the community as well.

Current version is 1.2, added 2005-07-03.

= Features =

What the the '''''ping kick''''' script can offer is to

* kick people with high ping based on

** a configurable ''pinglimit''
** after a configurable number of ''warnings'' (that only appear in the debug log on the server, if enabled)
** with a configurable ''interval'' between ping checks

* wait until a player has started playing before checking his/her ping, to avoid kicks on mapchange etc

= Getting Started =

To get started with the '''''ping kick''''' script you need to:

* Download the script [http://www.battlefield.no/filer/pafiledb.php?action=file&id=191 here], and rename it to ''pingkick.py''.
* Place it in the ''admin/standard_admin'' directory in your BF2 directory.
* Place the following code in the ''admin/standard_admin/__init__.py'' file in your BF2 directory:

<pre>
import pingkick
pingkick.init()
</pre>

For these changes to take effect you will need to restart your BF2 server.

= The Ping Kick Script =

This is the '''''ping script''''' as we use it at [http://web.archive.org/web/20081207025345/http://www.battlefield.no/ Battlefield.no]. Feel free to copy it, and since this is a wiki, feel free to modify it. But we would be very grateful of you appended a note to the updates section if you do.

== Configuration ==

The '''''ping kick''''' script comes with four settings you can change:

<pre>
autokick = 1 # Enables/disables autockicking
pinglimit = 150 # The ping limit, obviously ;-p
warnings = 3 # The number of warnings a player get before being kicked
interval = 30 # The interval between ping checks
</pre>

You can either change these settings directly in the script, or you can make sure there exists a dictionary in the ''bf2'' object, called ''adminoptions'', with the following keys:

<pre>
pk.pingAutoKick
pk.pingLimit
pk.warnings
pk.interval
</pre>

If they exist, they will override the defaults set in the '''''ping kick''''' script. If you use our [[Scripts:Modified_admin_script|modified admin script]], the ''adminoptions'' dictionary is made available, and populated with the values in the ''adminsettings.con'' file. So remember to add the above keys with appropriate values to the file. See [[Scripts:Modified_admin_script|here]] for more details on that.

== Output ==

There '''''ping kick''''' script prints a variety of messages, but to actually view them you will need to enable debug-logging. This is done by

* setting g_debug to 1 in ''<bf2>/python/bf2/__init__.py''
* enabling a writer, like we've done in [[Scripts:Modified_admin_script|modified admin script]]

When a player is cought by the '''''ping kick''''' script with a ping that is too high, a message like the following is logged:

<pre>[2005-07-03 04:44:28] PINGKICK: Player Panic[bf2.no] has exceeded the ping limit 2 time(s) </pre>

And when a player has been issued the maximum number of warnings, and is being kicked, a message like the following is logged:

<pre>[2005-07-03 04:44:43] PINGKICK: Kicking player Panic[bf2.no] for high ping ([120, 118, 118] > 100) </pre>

The numbers inside the braces are ping values that has been detected and that are in violation of the ping limit. And the number to the right of the ''greater than'' sign is the ping limit.

And five seconds before a player in violation of the ping limit is being kicked, a message like the following is printed in-game:

<pre>BF2.NO PING KICKER: Kicking player Panic[bf2.no] for high ping. (Limit is 100, player caught with [120, 118, 118].) </pre>

Again the numbers inside the braces are ping values that has been detected and that are in violation of the ping limit, and the first one is the ping limit.

== The Code ==

<pre>
# ------------------------------------------------------------------------
# Module: pingkick.py
# Authors: Kybber and Panic, Battlefield.no
# Version 1.2
# Description:
# This script kicks players with high ping, based on three different
# settings in the file 'adminsettings.con', loaded by the modified admin
# script (sv.adminScript = bfno_v1.1.py). See requirements for details.
# Requirements:
# None.
# Installation:
# Save this script as 'pingkick.py' in your <bf2>/admin/standard_admin directory,
# and add the lines 'import pingkick' and 'pingkick.init()' to the file
# '<bf2>/admin/standard_admin/__init__.py'.
#
# Changes from 1.0 to 1.1:
# - Added support for stand-alone operation. (Will use bf2.adminoptions if available)
# - The script now only checks ping while game status is 'Playing'
# - Switched from 'bfno' to prefix 'pk' for ping kick settings in 'bf2.adminoptions'.
# - Other, minor updates.
#
# Changes from 1.1. to 1.2:
# - Added methods to deactivate checking while players are not really playing.
# - Added safeguard against kicking a player that has gotten a disconnected "ping violater's" index.
# - Made the logging more verbose and ingame messaging less verbose.
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# C O N F I G U R A T I O N
# ------------------------------------------------------------------------
# Settings for auto-kicking:
autokick = 1 # Enables/disables autockicking
pinglimit = 150 # The ping limit, obviously ;-p
warnings = 3 # The number of warnings a player get before being kicked
interval = 30 # The interval between ping checks
# NB: These settings will be overridden by their counter-parts in
# bf2.adminoptions['pk.<autoKick|pingLimit|warnings|interval']
# if those are present.

# ------------------------------------------------------------------------
# I M P O R T
# ------------------------------------------------------------------------

import host
import bf2
from bf2 import g_debug

# ------------------------------------------------------------------------
# V A R I A B L E S
# ------------------------------------------------------------------------

# We need our own debug flag:
bfno_debug = False

# Some timers:
pktimer = None # Timer firing off the ping checker. Depends on the 'interval' variable.
kicktimer = None # Timer that delays kicking after the final warning has been issued.
msgtimer = None # Timer that delays the "activated" message after entering bf2.GameStatus.Playing

# List of people to kick for high ping. Will contain touples of p.index and p.getProfileId():
kicklist = []

# For keeping track of the game status:
gamestatus = None

# ------------------------------------------------------------------------
# F U N C T I O N S
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# The init function run by the standard_admin/__init__ functions:
# ------------------------------------------------------------------------
def init():
global interval,bfno_debug
try:
if bf2.bfno.debug: bfno_debug = True
except:
pass
if bfno_debug or bfno_debug: print 'PINGKICK: initializing pingkick script'
# Try to read the settings:
getSettings()
# Force at least 10 seconds between ping checks:
if interval < 10: interval = 10
# Print debug message if autokick is disabled:
if 1 != autokick:
if bfno_debug or bfno_debug: print 'PINGKICK: High ping autokick not enabled'

# Autokick is enabled, so hook it up:
else:
if bfno_debug or bfno_debug: print 'PINGKICK: Enabling kick for high ping. Limit = %s, max warnings = %s.' % (pinglimit, warnings)

# Register 'PlayerConnect' callback:
host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerSpawn', onPlayerSpawn, 1)
host.registerGameStatusHandler(onGameStatusChanged)

# Reset TK Warnings
for p in bf2.playerManager.getPlayers():
onPlayerConnect(p)

# PingKickTimer:
enableCheckTimer()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Get the settings from the bf2.adminsettings object:
# ------------------------------------------------------------------------
def getSettings():
global autokick,pinglimit,warnings,interval
# Try to access the autokick setting:
try:
if bfno_debug: print "PINGKICK: Reading settings from bf2.adminoptions:"
autokick = int(bf2.adminoptions['pk.autoKick'])
pinglimit = int(bf2.adminoptions['pk.pingLimit'])
warnings = int(bf2.adminoptions['pk.warnings'])
interval = int(bf2.adminoptions['pk.interval'])
except:
if bfno_debug: print "PINGKICK: WARNING - Could not get settings from 'bf2.adminoptions'. Using default values:"
if bfno_debug:
print " autokick : " + str(autokick)
print " pinglimit : " + str(pinglimit)
print " maxwarns : " + str(warnings)
print " interval : " + str(interval)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PlayerConnect" event:
# ------------------------------------------------------------------------
def onPlayerConnect(p):
"""Resets the ping warning counter for the player"""
resetPlayer(p)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PlayerSpawn" event:
# ------------------------------------------------------------------------
def onPlayerSpawn(p,s):
"""Sets the 'actuallyPlaying' flag for the player"""
p.actuallyPlaying = True
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PreGame" game status event:
# ------------------------------------------------------------------------
def onGameStatusChanged(status):
"""Enables the ping check timer"""
# Import variables, and update the game status:
global gamestatus, kicklist, msgtimer
gamestatus = status
if gamestatus == bf2.GameStatus.Playing and autokick:
if bfno_debug: print "PINGKICK: Setting msgtimer"
msgtimer = bf2.Timer(onMsgTimer,10,1)
# Return if not PreGame:
elif gamestatus == bf2.GameStatus.PreGame:
if bfno_debug: print "PINGKICK: Game status changed to PreGame. Get settings and and re-enabling check-timer"
# Reset the kicklist
kicklist = []
# Read the settings again:
getSettings()
# Enable the ping check timer:
enableCheckTimer()
elif gamestatus == bf2.GameStatus.EndGame:
# Reset players:
resetPlayers()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Reset the bfno pingscript variables placed in the player object:
# ------------------------------------------------------------------------
def resetPlayers():
# Reset TK Warnings and more:
for p in bf2.playerManager.getPlayers():
resetPlayer(p)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Reset the bfno pingscript variables placed in the player object:
# ------------------------------------------------------------------------
def resetPlayer(p):
# Reset TK Warnings and more:
p.pingWarnings = 0
p.detectedPing = []
p.actuallyPlaying = False
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for timer, that delays a message at round start:
# ------------------------------------------------------------------------
def onMsgTimer(data):
global msgtimer
if bfno_debug: print "PINGKICK: Entering onMsgTimer"
msg = "Activated! Kicking at " + str(pinglimit) + " after " + str(warnings) + " warnings."
sendMsg(msg)
msgtimer.destroy()
msgtimer = None
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send text messages to the server, using rcon game.sayAll:
# ------------------------------------------------------------------------
def sendMsg(msg):
# Sure you can edit this, and remove 'bf2.no'. But hey, why not give us the credit? ;-)
host.rcon_invoke("game.sayAll \"BF2.NO PING KICKER: " + str(msg) + "\"")
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Enable the pktimer:
# ------------------------------------------------------------------------
def enableKickTimer():
"""Enables the timer that runs the 'kickPlayers' functions"""
global kicktimer
if g_debug or bfno_debug: print "PINGKICK: Enabling the kicktimer..."
kicktimer = bf2.Timer(kickPlayers, 5, 1)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Enable the pktimer:
# ------------------------------------------------------------------------
def enableCheckTimer():
"""Enables the timer that runs the 'checkPing' function"""
global pktimer
if pktimer:
return True
else:
# Create the timer:
if g_debug or bfno_debug: print "PINGKICK: Timer not enabled. Enabling..."
pktimer = bf2.Timer(checkPing, interval, 1)
pktimer.setRecurring(interval)
# Print debug message telling the status of the timer:
if pktimer:
if g_debug and bfno_debug: print "PINGKICK: Time = %s" % (pktimer.getTime())
return True
else:
if bfno_debug: print "PINGKICK: Not enabled"
return False
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Loop all players, checking their ping, kick high-pinger:
# ------------------------------------------------------------------------
def checkPing(data):
"""Checks ping of all players, and kicks high-pingers"""

global kicklist

# We only want to check ping during rounds:
#if gamestatus != bf2.GameStatus.Playing: return

# Make sure our timer is enabled:
if not enableCheckTimer(): return

if bfno_debug: print "PINGKICK: Running checkPing"

# Loop all players
for p in bf2.playerManager.getPlayers():
# Do not check players that hasn't completed their "connect" yet:
#if not p.isConnected(): continue
if not p.actuallyPlaying: continue
# Get the player name. We'll use it often:
name = str(p.getName())
# Check the ping if the limit hasn't been reached:
ping = p.getPing()
# If we have a valid ping, check it, and issue a warning if the ping exceeds the limit:
if ping:
#if bfno_debug: print "PINGKICK: " + name + " has " + str(ping) + " in ping and has " + str(p.pingWarnings) + " Ping-warnings"
if ping > pinglimit:
p.pingWarnings += 1
p.detectedPing.append(ping)
if g_debug or bfno_debug: print "PINGKICK: Player " + name + " has exceeded the ping limit " + str(p.pingWarnings) + " time(s)"
#sendMsg("WARNING: " + name + " has exeeded the ping limit " + str(p.pingWarnings) + " time(s)")
# Issue a warning if a player has reached the maximum number of warnings. Will be kicked next time 'checkPing' is run:
if warnings <= p.pingWarnings:
sendMsg("Kicking player " + name + " for high ping. (Limit is " + str(pinglimit) + ", player caught with " + str(p.detectedPing) + ".)")
# Add the player to the kicklist:
kicklist.append((p.index,p.getProfileId()))
# Check of we shall enable the kicktimer:
if len(kicklist):
enableKickTimer()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Function run by the kicktimer:
# ------------------------------------------------------------------------
def kickPlayers(data):
"""Loops through 'kicklist', and kicks players accordingly."""
#print "PINGKICK: kickPlayers..."
global kicklist,kicktimer
for i in kicklist:
p = bf2.playerManager.getPlayerByIndex(i[0])
# Make sure we're not kicking a player that has gotten a disconnected "ping violater's" index:
if not p.getProfileId() == i[1]: continue
# Check if this player has reached the limit for maximum warnongs
if warnings <= p.pingWarnings:
# Kick if limit is reached:
if g_debug or bfno_debug: print "PINGKICK: Kicking player " + p.getName() + " for high ping (" + str(p.detectedPing) + " > "+str(pinglimit)+")"
result = host.rcon_invoke("admin.kickPlayer " + str(p.index))
kicklist = []
kicktimer.destroy()
kicktimer = None
# ------------------------------------------------------------------------
</pre>

== Updates ==

Please add a note here if you update the code above.

* 2005-07-03: Updated code and documentation to v1.2 (Panic)
* 2005-06-18: Updated code and documentation to v1.1 (Panic)
* 2005-06-18: Added documentation (Panic)
* 2005-06-17: Added v1.0 of the code (Panic)

Scripts:IdleKick

2018-06-22T15:24:32Z

Pireax: Created page with "<pre> # ------------------------------------------------------------------------ # Module: IdleKick.py # Authors: xlr8or, www.xlr8or.com # Version 2.02 # Description: #..."

<pre>
# ------------------------------------------------------------------------
# Module: IdleKick.py
# Authors: xlr8or, www.xlr8or.com
# Version 2.02
# Description:
# This script kicks players who are idle, based on the configuration settings below.
# Requirements:
# None.
# Installation:
# Save this script as 'IdleKick.py' in your <bf2>/admin/standard_admin directory,
# and add the lines 'import IdleKick' and 'IdleKick.init()' to the file
# '<bf2>/admin/standard_admin/__init__.py'.
# Credit:
# This script is based on the pingkick script from the guys at bf2.no
# Format is mainly the same as what they did, and where I could use their
# code I have shamelessly done so.
# Credit therefor goes to Kybber and Panic, Battlefield.no
# History:
# Autobalancing is a nice feature, but not when a large part of your team
# is doing something else, while staying ingame to not lose their slot.
# BF2 does not have a spectator ability, so if you're not participating,
# you're letting your team down!
# Version 1.00 to 2.00:
# Cleaned some code up, added the ability to exclude clanmembers.
# Version 2.00 to 2.01:
# Cleaned and corrected some global def's.
# Version 2.01 to 2.02:
# Fixed the clantag protection.
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# C O N F I G U R A T I O N
# ------------------------------------------------------------------------
# Settings for auto-kicking:
autokick = 1 # Enables/disables autokicking
warnings = 10 # The number of checks/warns a player has to fail/get before being kicked
interval = 30 # The interval between idle checks
minplayers = 5 # The minimum ammount of players online before checking idle players.
announceme = 0 # Announce the module at roundstart?
warnme = 1 # Warn the idle player 3 intervals before the maximum nr of warnings is reached?

clantags = ["[XLR]","[xlr]","xlr8or"] # Clantags to protect from being kicked

# ------------------------------------------------------------------------
# I M P O R T
# ------------------------------------------------------------------------

import host
import bf2
from bf2 import g_debug

# ------------------------------------------------------------------------
# V A R I A B L E S
# ------------------------------------------------------------------------

# Let's set up our debug flag:
xlr_debug = False

# The timers:
IkCheckTimer = None # Timer firing off the idle checker. Depends on the 'interval' variable.
KickTimer = None # Timer that delays kicking after the final warning has been issued.
AnnounceTimer = None # Timer that delays the "activated" message after entering bf2.GameStatus.Playing

# List of people to kick for high idle. Will contain touples of p.index and p.getProfileId():
kicklist = []

# For keeping track of the game status:
gamestatus = None

# ------------------------------------------------------------------------
# F U N C T I O N S
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# The init function is run by the standard_admin/__init__ functions:
# ------------------------------------------------------------------------
def init():

if g_debug or xlr_debug: print 'IDLEKICK: initializing IdleKick script'
# Force at least 20 seconds between idle checks:
if interval < 10: interval = 10
# Print debug message if autokick is disabled:
if autokick != 1:
if g_debug or xlr_debug: print 'IDLEKICK: Idle autokick not enabled'

# Autokick is enabled, so hook it up:
else:
if g_debug or xlr_debug: print 'IDLEKICK: Enabling kick for being idle. Max. checkfails = %s.' % (warnings)

# Register 'PlayerConnect' callback:
host.registerHandler('PlayerConnect', onPlayerConnect, 1)
host.registerHandler('PlayerSpawn', onPlayerSpawn, 1)
host.registerGameStatusHandler(onGameStatusChanged)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PlayerConnect" event:
# ------------------------------------------------------------------------
def onPlayerConnect(p):
#Resets the idle warning counter for the player
resetPlayer(p)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PlayerSpawn" event:
# ------------------------------------------------------------------------
def onPlayerSpawn(p,s):
# Sets the 'actuallyPlaying' flag for the player
p.actuallyPlaying = True
# We can reset the warnings, since the player has actually spawned.
p.idleWarnings = 0
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for the "PreGame" game status event:
# ------------------------------------------------------------------------
def onGameStatusChanged(status):
# Enables the idle check timer
# Import variables, and update the game status:
global gamestatus, kicklist, AnnounceTimer

gamestatus = status
if gamestatus == bf2.GameStatus.Playing:
if announceme ==1:
if g_debug or xlr_debug: print "IDLEKICK: Round Started. Setting AnnounceTimer"
AnnounceTimer = bf2.Timer(onAnnounceTimer,10,1)
if g_debug or xlr_debug: print "IDLEKICK: Round Started. (Re-)enabling check-timer"
# Enable the idle check timer:
enableCheckTimer()
elif gamestatus == bf2.GameStatus.PreGame:
if g_debug or xlr_debug: print "IDLEKICK: Game status changed to PreGame. Killing check-timer"
# Kill the check-timer
disableCheckTimer()
elif gamestatus == bf2.GameStatus.Paused:
if g_debug or xlr_debug: print "IDLEKICK: Game status changed to Paused. Killing check-timer"
# Kill the check-timer
disableCheckTimer()
elif gamestatus == bf2.GameStatus.EndGame:
if g_debug or xlr_debug: print "IDLEKICK: Game status changed to EndGame. Reset Players, Kicklist and killing check-timer"
# Kill the check-timer
disableCheckTimer()
# Reset the kicklist
kicklist = []
# Reset players:
resetPlayers()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Reset the idlescript variables placed in the player object:
# ------------------------------------------------------------------------
def resetPlayers():
# Reset Warnings and stuff:
if g_debug or xlr_debug: print "IDLEKICK: Resetting Players"
for p in bf2.playerManager.getPlayers():
resetPlayer(p)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Reset the idlescript variables placed in the player object:
# ------------------------------------------------------------------------
def resetPlayer(p):
# Reset Warnings and stuff:
p.idleWarnings = 0
p.actuallyPlaying = False
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Callback function for timer, that delays a message at round start:
# ------------------------------------------------------------------------
def onAnnounceTimer(data):
global AnnounceTimer

if g_debug or xlr_debug: print "IDLEKICK: Entering onAnnounceTimer... Sending the Activated announcement"
msg = "Activated! Kicking after " + str(warnings) + " checks."
sendMsg(msg)
AnnounceTimer.destroy()
AnnounceTimer = None
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Send text messages to the server, using rcon game.sayAll:
# ------------------------------------------------------------------------
def sendMsg(msg):
# Sure you can edit this. But hey, why not give us the credit? ;-)
host.rcon_invoke("game.sayAll \"[XLR]No-Idle: " + str(msg) + "\"")
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Enable the KickTimer:
# ------------------------------------------------------------------------
def enableKickTimer():
# Enables the timer that runs the 'kickPlayers' functions
global KickTimer

if g_debug or xlr_debug: print "IDLEKICK: Enabling the kicktimer..."
KickTimer = bf2.Timer(kickPlayers, 5, 1)
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Enable the IkCheckTimer:
# ------------------------------------------------------------------------
def enableCheckTimer():
# Enables the timer that runs the 'checkidle' function
global IkCheckTimer

if IkCheckTimer:
if g_debug or xlr_debug: print "IDLEKICK: IkCheckTimer (already) running: Next check @ %s" % (IkCheckTimer.getTime())
return True
else:
# Create the timer:
if g_debug or xlr_debug: print "IDLEKICK: Timer not enabled. Enabling..."
IkCheckTimer = bf2.Timer(checkidle, interval, 1)
IkCheckTimer.setRecurring(interval)
# Print debug message telling the status of the timer:
if IkCheckTimer:
if g_debug or xlr_debug: print "IDLEKICK: First check @ %s" % (IkCheckTimer.getTime())
return True
else:
if g_debug or xlr_debug: print "IDLEKICK: ERROR: IkCheckimer Not enabled in def enableCheckTimer()"
return False
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Disable the IkCheckTimer:
# ------------------------------------------------------------------------
def disableCheckTimer():
global IkCheckTimer

IkCheckTimer.destroy()
IkCheckTimer = None

# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Loop all players, checking their idle, kick high-idleer:
# ------------------------------------------------------------------------
def checkidle(data):
# Checks idle of all players, and kicks idlers
global kicklist, gamestatus

# We only want to check idle during rounds:
if gamestatus != bf2.GameStatus.Playing: return

# Make sure our timer is enabled:
if not enableCheckTimer(): return

if bf2.playerManager.getNumberOfPlayers() < minplayers:
if g_debug or xlr_debug: print "IDLEKICK: Not enough players to check for idlers..."
return

if g_debug or xlr_debug: print "IDLEKICK: Running checkidle"

# Loop all players
for p in bf2.playerManager.getPlayers():
# Do not check players that haven't completed their "connect" yet:
if not p.isConnected():
if g_debug or xlr_debug: print "IDLEKICK: Player not yet connected, continuing..."
continue
if p.isAlive():
if g_debug or xlr_debug: print "IDLEKICK: Player is already playing, continuing..."
continue
if p.isManDown():
if g_debug or xlr_debug: print "IDLEKICK: Player in ManDown state, continuing..."
continue
# Get the player name. We'll use it often:
name = str(p.getName())

# Prevent Clanmembers from being kicked
skip = 0
for clantag in clantags:
if name.find(clantag)>-1:
skip = 1
break
if skip == 1: continue

# If we have a valid idle, check it, and issue a warning if the idle exceeds the limit:
p.idleWarnings += 1
if g_debug or xlr_debug: print "IDLEKICK: Player " + name + " has been detected as idle " + str(p.idleWarnings) + " time(s)"
if warnme == 1 and p.idleWarnings == (warnings - 3):
#tmp = p.idleWarnings * interval / 60
sendMsg("WARNING: " + name + " has not returned to duty for quite some time now. Move in fast, you're about to be court marshalled!")
# Issue a warning if a player has reached the maximum number of warnings. Will be kicked next time 'checkidle' is run:
if warnings <= p.idleWarnings:
#tmp = p.idleWarnings * intervals / 60
sendMsg("Desertion Violation: " + name + " is being removed for not returning to duty in time! (aka idling)")
# Add the player to the kicklist:
kicklist.append((p.index,p.getProfileId()))

# Check of we shall enable the kicktimer:
if len(kicklist):
enableKickTimer()
# ------------------------------------------------------------------------

# ------------------------------------------------------------------------
# Function run by the kicktimer:
# ------------------------------------------------------------------------
def kickPlayers(data):
# Loops through 'kicklist', and kicks players accordingly.
#print "IDLEKICK: kickPlayers..."
global kicklist, KickTimer

for i in kicklist:
p = bf2.playerManager.getPlayerByIndex(i[0])
# Make sure we're not kicking a player that has gotten an already disconnected "violater's" index:
if not p.getProfileId() == i[1]: continue
# Check if this player indeed has reached the limit for maximum warnings
if warnings <= p.idleWarnings:
# Kick if limit is reached:
if g_debug or xlr_debug: print "IDLEKICK: Kicking player " + p.getName() + " for being idle."
result = host.rcon_invoke("admin.kickPlayer " + str(p.index))
kicklist = []
KickTimer.destroy()
KickTimer = None
# ------------------------------------------------------------------------
</pre>

Scripts:CountryFilter

2018-06-22T15:24:07Z

Pireax: Created page with "== Description == The feature of CountryFilter is as follows. * This script can display country name by finding the country from IP-address of the player. * This script prov..."

== Description ==

The feature of CountryFilter is as follows.

* This script can display country name by finding the country from IP-address of the player.
* This script provides access control (allow/deny) based on player country name.
* This script uses GeoIP Free Country, and its accuracy of conversion is approximately 97%.

== The Code ==

<code> </code>

<code> </code><pre>
# CountryFilter.py
#
# Copyright (C) 2005 Guwashi <guwashi[AT]fooos[DOT]com>
#
# 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.1 of the License, or (at your option) any later version.
#
# This library 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 library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

# Description:
#
# The feature of CountryFilter is as follows.
#
# - This script can display country name by finding the country
# from IP-address of the player.
#
# - This script provides access control (allow/deny) based on
# player country name.
#
# - This script uses GeoIP Free Country, and its accuracy of
# conversion is approximately 97%.
#
# If you want to see latest information of this script, please
# acccess this URL.
# http://d3.jpn.org/
#
#
# Download:
#
# http://d3.jpn.org/bf2/CountryFilter-bf2-1.0.0.zip
# http://www.maxmind.com/download/geoip/database/GeoIP.dat.gz
#
#
# Install:
#
# - Copy CountryFilter.py and PurePythonGeoIP.py to
# '<bf2>/Admin/standard_admin' directory.
#
# - Add the lines 'import CountryFilter' and 'CountryFilter.init()'
# to the file '<bf2>/admin/standard_admin/__init__.py'.
#
# ex.)
# import autobalance
# import tk_punish
# import CountryFilter
#
# autobalance.init()
# tk_punish.init()
# CountryFilter.init()
#
# - Download GeoIP.dat from
# http://www.maxmind.com/download/geoip/database/GeoIP.dat.gz
# and extract it.
#
# - Copy GeoIP.dat to '<bf2>' directory.
#
# - Finally, it must be the following.
#
# ex.)
# <bf2>/Admin/standard_admin/CountryFilter.py
# <bf2>/Admin/standard_admin/PurePythonGeoIP.py
# <bf2>/GeoIP.dat
#
#
# Config:
#
# see also
# http://d3.jpn.org/hl2/CountryFilter-en.html (English)
# http://d3.jpn.org/hl2/CountryFilter-jp.html (Japanese)
#
# - You can customize the print format of country.
#
# - Country code by two characters. ex.) JP
#
cf_country_print_mode = 'code'
#
# - Country code by three characters. ex.) JPN
#
#cf_country_print_mode = 'code3'
#
# - Long country name. ex.) Japan
#
#cf_country_print_mode = 'name'
#
# - You can customize the message format when script allow/deny the
# connection according to the country of the player.
#
# - Message format when player was allowed to connect.
# %(name)s is replaced with player name.
# %(country)s is replaced with country name.
# The message will not displayed when setting as
# cf_allow_message = ''.
#
cf_allow_message = '%(name)s (Country: %(country)s) was allowed to connect.'
#
# - Message format when player was denied to connect.
# %(name)s is replaced with player name.
# %(country)s is replaced with country name.
# The message will not displayed when setting as
# cf_deny_message = ''.
#
cf_deny_message = '%(name)s (Country: %(country)s) was rejected by CountryFilter.'
#
# - Specify the country(s) which is excluded from printing
# messages.
# Available value is same as cf_allow_from and cf_deny_from.
#
cf_message_exclude_from = ''
#
# - Allowing/denying the connection according to the country of the
# player.
#
# You can limit the connection by using cf_allow_from,
# cf_deny_from, and cf_order. Please specify this by the country
# code of two characters. Basically, it is the same as the
# mod_access module of Apache. See this URL.
#
# http://httpd.apache.org/docs/mod/mod_access.html
#
# - cf_allow_from
#
# cf_allow_from specify the country(s) which is allowed to
# connect. Available value of cf_allow_from is 'all', '', '--'
# and country code by 2 characters. If you want to specify
# multiple value, use space as delimiter. Set 'all', if you want
# to allow all countries. When '' (null string) is specified,
# nothing is done. '--' is unknown country. Note: when you
# connect to server from LAN, its IP-address is 192.168.xxx.xxx,
# so this script cannot find valid country name. Therefore if
# you want to allow to connect from LAN, you must specify '--'.
#
# ex.1)
# # Allowing all countries.
# cf_allow_from = 'all'
#
# ex.2)
# # Allowing only JP, US and LAN.
# cf_allow_from = 'JP US --'
#
# ex.3)
# # Doing nothing.
# cf_allow_from = ''
#
# - cf_deny_from
#
# cf_deny_from specify the country(s) which is deny to
# connect. Available value of cf_deny_from is quite the same as
# cf_allow_from.
#
# - cf_order
#
# cf_order controls the default access state and the order in
# which cf_allow_from and cf_deny_from are evaluated. The value
# of cf_order must be "deny,allow" or "allow,deny". The default
# value is "deny,allow".
#
# ex.1)
# # It is evaluated in order of deny and allow.
# # Access is allowed by default.
# cf_order = 'deny,allow'
#
# ex.2)
# # It is evaluated in order of allow and deny.
# # Access is denied by default.
# cf_order = 'allow,deny'
#
# - Examples
#
# Some typical usages are shown as follows.
#
# - Allowing all countries. (default)
#
cf_order = 'deny,allow'
cf_deny_from = ''
cf_allow_from = 'all'
#
# - Allowing only JP, US and LAN. Others are denied.
#
#cf_order = 'deny,allow'
#cf_deny_from = 'all'
#cf_allow_from = 'JP US --'
#
# - Denying only JP. Others are allowed.
#
#cf_order = 'allow,deny'
#cf_allow_from = 'all'
#cf_deny_from = 'JP'
#
# If you want to find country code, refer this page.
# http://www.maxmind.com/app/iso3166
#
# - Specify the path of GeoIP.dat file. Default path is
# <bf2>/GeoIP.dat.
#
cf_geoipdat_path = 'GeoIP.dat'
#
#
# etc.:
#
# - The CountryFilter is licensed under the GPL. For details see the
# COPYING file.
#
# - This product includes GeoIP data created by MaxMind, available
# from http://maxmind.com/
#
#
# Author:
#
# Guwashi
# - E-Mail
# guwashi[AT]fooos[DOT]com
# - Web
# http://d3.jpn.org/
# - Forums
# not yet.
#
# ChangeLog:
#
# - 1.0.0 2005/07/07
# first public release.
# - 1.0.0rc1 2005/07/06
# added cf_country_print_mode, cf_message_exclude_from and
# cf_geoipdat_path.
# - 1.0.0b 2005/07/04
# first beta.

import sys
import re
import host
import bf2
import PurePythonGeoIP
from PurePythonGeoIP import GeoIP

COUNTRYFILTER_VERSION = '1.0.0'

gi = None

def init():
'''Create a new GeoIP object and register callback functions.'''
global gi, cf_geoipdat_path
printLog('init', 'start...')
gi = GeoIP.open(cf_geoipdat_path, GeoIP.GEOIP_STANDARD)
printLog('init', 'testing: 133.1.1.1 ==> ' + gi.country_code_by_addr('133.1.1.1'))
host.registerHandler('PlayerConnect', onPlayerConnect, 1)
printLog('init', 'done')

def onPlayerConnect(player):
'''Examine players country and allow/deny to connect.'''
global cf_allow_message, cf_deny_message
printLog('onPlayerConnect', 'start...')
printLog('onPlayerConnect', 'player.index == ' + str(player.index))
printLog('onPlayerConnect', 'player.getName() == ' + str(player.getName()))
printLog('onPlayerConnect', 'player.getAddress() == ' + str(player.getAddress()))
countryId = gi.id_by_addr(str(player.getAddress()))
countryCode = GeoIP.id_to_country_code(countryId)
country = idToCountry(countryId)
printLog('onPlayerConnect', 'country == ' + country)
if isAllowConnect(countryCode):
if 0 < len(cf_allow_message) and (not isMessageExcludeFrom(countryCode)):
message = cf_allow_message % {'name':player.getName(), 'country':country}
printConsole(message)
sayAll(message)
pass # do nothing
else:
if 0 < len(cf_deny_message) and (not isMessageExcludeFrom(countryCode)):
message = cf_deny_message % {'name':player.getName(), 'country':country}
printConsole(message)
sayAll(message)
host.rcon_invoke('admin.kickPlayer ' + str(player.index)) # kick!
printLog('onPlayerConnect', 'done')

def printLog(method_name, message):
'''Print log to stdout.'''
if bf2.g_debug:
print '[CF]: ' + str(method_name) + ': ' + str(message)
sys.stdout.flush()

def printConsole(message):
'''Print log to server console.'''
host.rcon_invoke('echo "' + str(message) + '"')

def sayAll(message):
'''Say message to to all players.'''
host.rcon_invoke('game.sayAll "' + str(message) + '"')

def isAllowConnect(countryCode):
'''Is player allowed to connect?'''
# http://httpd.apache.org/docs/mod/mod_access.html
# TODO: use regular expressions
global cf_order, cf_allow_from, cf_deny_from
result = True
if 'allow,deny' == cf_order:
result = False # deny
if -1 != cf_allow_from.find('all'):
result = True
if -1 != cf_allow_from.find(countryCode):
result = True
if -1 != cf_deny_from.find('all'):
result = False
if -1 != cf_deny_from.find(countryCode):
result = False
else: # 'deny,allow' (default)
result = True; # allow
if -1 != cf_deny_from.find('all'):
result = False
if -1 != cf_deny_from.find(countryCode):
result = False
if -1 != cf_allow_from.find('all'):
result = True
if -1 != cf_allow_from.find(countryCode):
result = True
return result;

def isMessageExcludeFrom(countryCode):
'''Is message allowed to print?'''
global cf_message_exclude_from
result = False
if -1 != cf_message_exclude_from.find('all'):
result = True
if -1 != cf_message_exclude_from.find(countryCode):
result = True
return result

def idToCountry(countryId):
'''Convert country id to country representation.'''
global cf_country_print_mode
if 'code3' == cf_country_print_mode:
return GeoIP.id_to_country_code3(countryId)
elif 'name' == cf_country_print_mode:
return GeoIP.id_to_country_name(countryId)
else: # 'code' (default)
return GeoIP.id_to_country_code(countryId)
</pre>

<code></code> <code> </code>

<code> </code><pre>
#! /usr/bin/python

# PurePythonGeoIP.py
#
# Copyright (C) 2005 Guwashi <guwashi[AT]fooos[DOT]com>
#
# 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.1 of the License, or (at your option) any later version.
#
# This library 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 library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

# This code is based on
# http://www.maxmind.com/app/python
# http://www.maxmind.com/download/geoip/api/pureperl

import re
import struct

PUREPYTHONGEOIP_VERSION = '1.0.0'

def nreverse(sequence):
'''nreverse in Common Lisp. :)'''
sequence.reverse()
return sequence

class GeoIP:
__STANDARD_RECORD_LENGTH = 3
__GEOIP_COUNTRY_EDITION = 106
__GEOIP_COUNTRY_BEGIN = 16776960

__COUNTRIES = ('--','AP','EU','AD','AE','AF','AG','AI','AL','AM','AN','AO','AQ','AR','AS','AT','AU','AW','AZ','BA','BB','BD','BE','BF','BG','BH','BI','BJ','BM','BN','BO','BR','BS','BT','BV','BW','BY','BZ','CA','CC','CD','CF','CG','CH','CI','CK','CL','CM','CN','CO','CR','CU','CV','CX','CY','CZ','DE','DJ','DK','DM','DO','DZ','EC','EE','EG','EH','ER','ES','ET','FI','FJ','FK','FM','FO','FR','FX','GA','GB','GD','GE','GF','GH','GI','GL','GM','GN','GP','GQ','GR','GS','GT','GU','GW','GY','HK','HM','HN','HR','HT','HU','ID','IE','IL','IN','IO','IQ','IR','IS','IT','JM','JO','JP','KE','KG','KH','KI','KM','KN','KP','KR','KW','KY','KZ','LA','LB','LC','LI','LK','LR','LS','LT','LU','LV','LY','MA','MC','MD','MG','MH','MK','ML','MM','MN','MO','MP','MQ','MR','MS','MT','MU','MV','MW','MX','MY','MZ','NA','NC','NE','NF','NG','NI','NL','NO','NP','NR','NU','NZ','OM','PA','PE','PF','PG','PH','PK','PL','PM','PN','PR','PS','PT','PW','PY','QA','RE','RO','RU','RW','SA','SB','SC','SD','SE','SG','SH','SI','SJ','SK','SL','SM','SN','SO','SR','ST','SV','SY','SZ','TC','TD','TF','TG','TH','TJ','TK','TM','TN','TO','TP','TR','TT','TV','TW','TZ','UA','UG','UM','US','UY','UZ','VA','VC','VE','VG','VI','VN','VU','WF','WS','YE','YT','YU','ZA','ZM','ZR','ZW','A1','A2')
__CODE3S = ('--','AP','EU','AND','ARE','AFG','ATG','AIA','ALB','ARM','ANT','AGO','AQ','ARG','ASM','AUT','AUS','ABW','AZE','BIH','BRB','BGD','BEL','BFA','BGR','BHR','BDI','BEN','BMU','BRN','BOL','BRA','BHS','BTN','BV','BWA','BLR','BLZ','CAN','CC','COD','CAF','COG','CHE','CIV','COK','CHL','CMR','CHN','COL','CRI','CUB','CPV','CX','CYP','CZE','DEU','DJI','DNK','DMA','DOM','DZA','ECU','EST','EGY','ESH','ERI','ESP','ETH','FIN','FJI','FLK','FSM','FRO','FRA','FX','GAB','GBR','GRD','GEO','GUF','GHA','GIB','GRL','GMB','GIN','GLP','GNQ','GRC','GS','GTM','GUM','GNB','GUY','HKG','HM','HND','HRV','HTI','HUN','IDN','IRL','ISR','IND','IO','IRQ','IRN','ISL','ITA','JAM','JOR','JPN','KEN','KGZ','KHM','KIR','COM','KNA','PRK','KOR','KWT','CYM','KAZ','LAO','LBN','LCA','LIE','LKA','LBR','LSO','LTU','LUX','LVA','LBY','MAR','MCO','MDA','MDG','MHL','MKD','MLI','MMR','MNG','MAC','MNP','MTQ','MRT','MSR','MLT','MUS','MDV','MWI','MEX','MYS','MOZ','NAM','NCL','NER','NFK','NGA','NIC','NLD','NOR','NPL','NRU','NIU','NZL','OMN','PAN','PER','PYF','PNG','PHL','PAK','POL','SPM','PCN','PRI','PSE','PRT','PLW','PRY','QAT','REU','ROM','RUS','RWA','SAU','SLB','SYC','SDN','SWE','SGP','SHN','SVN','SJM','SVK','SLE','SMR','SEN','SOM','SUR','STP','SLV','SYR','SWZ','TCA','TCD','TF','TGO','THA','TJK','TKL','TLS','TKM','TUN','TON','TUR','TTO','TUV','TWN','TZA','UKR','UGA','UM','USA','URY','UZB','VAT','VCT','VEN','VGB','VIR','VNM','VUT','WLF','WSM','YEM','YT','YUG','ZAF','ZMB','ZR','ZWE','A1','A2')
__NAMES = ("--","Asia/Pacific Region","Europe","Andorra","United Arab Emirates","Afghanistan","Antigua and Barbuda","Anguilla","Albania","Armenia","Netherlands Antilles","Angola","Antarctica","Argentina","American Samoa","Austria","Australia","Aruba","Azerbaijan","Bosnia and Herzegovina","Barbados","Bangladesh","Belgium","Burkina Faso","Bulgaria","Bahrain","Burundi","Benin","Bermuda","Brunei Darussalam","Bolivia","Brazil","Bahamas","Bhutan","Bouvet Island","Botswana","Belarus","Belize","Canada","Cocos (Keeling) Islands","Congo, The Democratic Republic of the","Central African Republic","Congo","Switzerland","Cote D'Ivoire","Cook Islands","Chile","Cameroon","China","Colombia","Costa Rica","Cuba","Cape Verde","Christmas Island","Cyprus","Czech Republic","Germany","Djibouti","Denmark","Dominica","Dominican Republic","Algeria","Ecuador","Estonia","Egypt","Western Sahara","Eritrea","Spain","Ethiopia","Finland","Fiji","Falkland Islands (Malvinas)","Micronesia, Federated States of","Faroe Islands","France","France, Metropolitan","Gabon","United Kingdom","Grenada","Georgia","French Guiana","Ghana","Gibraltar","Greenland","Gambia","Guinea","Guadeloupe","Equatorial Guinea","Greece","South Georgia and the South Sandwich Islands","Guatemala","Guam","Guinea-Bissau","Guyana","Hong Kong","Heard Island and McDonald Islands","Honduras","Croatia","Haiti","Hungary","Indonesia","Ireland","Israel","India","British Indian Ocean Territory","Iraq","Iran, Islamic Republic of","Iceland","Italy","Jamaica","Jordan","Japan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Comoros","Saint Kitts and Nevis",
"Korea, Democratic People's Republic of","Korea, Republic of","Kuwait","Cayman Islands","Kazakhstan","Lao People's Democratic Republic","Lebanon","Saint Lucia","Liechtenstein","Sri Lanka","Liberia","Lesotho","Lithuania","Luxembourg","Latvia","Libyan Arab Jamahiriya","Morocco","Monaco","Moldova, Republic of","Madagascar","Marshall Islands","Macedonia","Mali","Myanmar","Mongolia","Macau","Northern Mariana Islands","Martinique","Mauritania","Montserrat","Malta","Mauritius","Maldives","Malawi","Mexico","Malaysia","Mozambique","Namibia","New Caledonia","Niger","Norfolk Island","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","Niue","New Zealand","Oman","Panama","Peru","French Polynesia","Papua New Guinea","Philippines","Pakistan","Poland","Saint Pierre and Miquelon","Pitcairn Islands","Puerto Rico","Palestinian Territory, Occupied","Portugal","Palau","Paraguay","Qatar","Reunion","Romania","Russian Federation","Rwanda","Saudi Arabia","Solomon Islands","Seychelles","Sudan","Sweden","Singapore","Saint Helena","Slovenia","Svalbard and Jan Mayen","Slovakia","Sierra Leone","San Marino","Senegal","Somalia","Suriname","Sao Tome and Principe","El Salvador","Syrian Arab Republic","Swaziland","Turks and Caicos Islands","Chad","French Southern Territories","Togo","Thailand","Tajikistan","Tokelau","Turkmenistan","Tunisia","Tonga","East Timor","Turkey","Trinidad and Tobago","Tuvalu","Taiwan","Tanzania, United Republic of","Ukraine","Uganda","United States Minor Outlying Islands","United States","Uruguay","Uzbekistan","Holy See (Vatican City State)","Saint Vincent and the Grenadines","Venezuela","Virgin Islands, British","Virgin Islands, U.S.","Vietnam","Vanuatu","Wallis and Futuna","Samoa","Yemen","Mayotte","Yugoslavia","South Africa","Zambia","Zaire","Zimbabwe",
"Anonymous Proxy","Satellite Provider")

__RE_IP_DOTTED_FORM = re.compile("^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")

GEOIP_STANDARD = 0 # TODO

def addr_to_num(ip_address):
'''Convert IP-address to number.'''
# a = [int(s) for s in re.split('\.', ip_address)]
a = map(int, re.split('\.', ip_address))
return a[0] * 16777216L + a[1] * 65536L + a[2] * 256L + a[3]

def open(db_file, flags):
'''Create a new GeoIP object.'''
gi = GeoIP()
gi.db_file = db_file
gi.flags = flags # TODO
gi.fh = open(db_file, 'rb')
gi.databaseType = GeoIP.__GEOIP_COUNTRY_EDITION # TODO
gi.record_length = GeoIP.__STANDARD_RECORD_LENGTH # TODO
gi.databaseSegments = GeoIP.__GEOIP_COUNTRY_BEGIN # TODO
return gi

def new(flags):
'''Create a new GeoIP object.'''
return GeoIP.open('/usr/local/share/GeoIP/GeoIP.dat', flags)

def __seek_country(self, ipnum):
'''Seek GeoIP data file to find country id.'''
fh = self.fh
record_length = self.record_length
databaseSegments = self.databaseSegments
offset = 0
x0 = -1
x1 = -1
for depth in nreverse(range(32)):
fh.seek(offset * 2 * record_length, 0)
x0 = fh.read(record_length)
x1 = fh.read(record_length)
x0, = struct.unpack("<1l", x0 + "\0")
x1, = struct.unpack("<1l", x1 + "\0")
if ipnum & (1L << depth):
if x1 >= databaseSegments:
return x1
offset = x1
else:
if x0 >= databaseSegments:
return x0
offset = x0
raise Exception('Error Traversing Database for ipnum = %d - Perhaps database is corrupt?' % ipnum) # TODO

def id_by_addr(self, ip_address):
'''Find country id by IP-address.'''
if self.__RE_IP_DOTTED_FORM.match(ip_address):
return self.__seek_country(self.addr_to_num(ip_address)) - self.__GEOIP_COUNTRY_BEGIN
else:
return 0

def id_to_country_code(id):
'''Convert country id to country code.'''
return GeoIP.__COUNTRIES[id]

def id_to_country_code3(id):
'''Convert country id to country code.'''
return GeoIP.__CODE3S[id]

def id_to_country_name(id):
'''Convert country id to country code.'''
return GeoIP.__NAMES[id]

def country_code_by_addr(self, ip_address):
'''Find country code by IP-address.'''
return GeoIP.id_to_country_code(self.id_by_addr(ip_address))

def country_code3_by_addr(self, ip_address):
'''Find country code3 by IP-address.'''
return GeoIP.id_to_country_code3(self.id_by_addr(ip_address))

def country_name_by_addr(self, ip_address):
'''Find country name by IP-address.'''
return GeoIP.id_to_country_name(self.id_by_addr(ip_address))

addr_to_num = staticmethod(addr_to_num)
open = staticmethod(open)
new = staticmethod(new)
id_to_country_code = staticmethod(id_to_country_code)
id_to_country_code3 = staticmethod(id_to_country_code3)
id_to_country_name = staticmethod(id_to_country_name)

if '__main__' == __name__:
import sys
import string

argc = len(sys.argv)
gi = None
if 2 == argc:
gi = GeoIP.new(GeoIP.GEOIP_STANDARD)
elif 3 == argc:
gi = GeoIP.open(sys.argv[2], GeoIP.GEOIP_STANDARD)
else:
print "Usage:\n %s <ipaddress> [geoipdatafile]" % sys.argv[0]
sys.exit(1)

ip = sys.argv[1]
id = str(gi.id_by_addr(ip))
code = gi.country_code_by_addr(ip)
code3 = gi.country_code3_by_addr(ip)
name = gi.country_name_by_addr(ip)

print string.join(['ipaddress', 'id', 'code', 'code3', 'name'], "\t")
print string.join([ip, id, code, code3, name], "\t")
</pre>

Scripts:ReserveSlots

2018-06-22T15:23:47Z

Pireax: Created page with "This will open a file "knownplayers.txt" and use it to maintain a list of players who should get priority. To use it, log in with rcon and type "rcon addPlayer playerName" or..."

This will open a file "knownplayers.txt" and use it to maintain a list of players who should get priority.

To use it, log in with rcon and type "rcon addPlayer playerName" or "rcon removePlayer playerName". You can change the server mode with "rcon changeMode mode" where mode is public, private or semiprivate. Public is anything goes, private is list only and semiprivate let's anyone join but will kick players off the list to make room for players on the list if the server gets full. Semiprivate will only kick commanders as a last resort.

There's also "rcon numFromList" to get the number of people on the server who are on the list. "rcon isOnList playername" is obvious, and "rcon currMode" will tell you what mode the server is in.

Enjoy!

Call this file kickoutsiders.py and put it in your standard_admin folder along with a knownplayers.txt file.

kickoutsiders.py:

<pre>
import host
import bf2

scriptName = 'Doc & sirSolarius Kicker v1.7'
fileName = 'admin/standard_admin/knownplayers.txt'
knownPlayers = []
mode = 1

def init():
print "Starting " + scriptName
global knownPlayers, fileName
playersFile = file(fileName, 'r')
for i in playersFile:
knownPlayers.append(i.rstrip())
playersFile.close()
print knownPlayers
host.registerHandler('PlayerConnect', onPlayerConnect, 1)

def onPlayerConnect(aPlayer):
global knownPlayers, mode

# private
if mode == 0:
if not aPlayer.getName() in knownPlayers:
host.rcon_invoke('game.sayAll "' + scriptName + ': Player ' + aPlayer.getName() + ' was not on the list!' + '"')
host.rcon_invoke('admin.kickPlayer ' + str(aPlayer.index))

# semiprivate
elif mode == 1:
#if we're at capacity (new person fills our extra spot)
if bf2.playerManager.getNumberOfPlayers() == bf2.serverSettings.getMaxPlayers():
# if he's not on the list, put him back where he came from
if not aPlayer.getName() in knownPlayers:
host.rcon_invoke('game.sayAll "' + scriptName + ': Player ' + aPlayer.getName() + ' kicked: no room for people off the list!' + '"')
host.rcon_invoke('admin.kickPlayer ' + str(aPlayer.index))
return
# he's on the list: kick someone who isn't
else:
currPlayers=bf2.playerManager.getPlayers()
foundCommander=0
commander=aPlayer
for i in currPlayers:
# if we found someone to toss out
if not i.getName() in knownPlayers:
# if he's the commander, try to find someone else
if i.isCommander():
commander=i
foundCommander=1
else:
host.rcon_invoke('game.sayAll "' + scriptName + ': Player ' + i.getName() + ' kicked for ' + aPlayer.getName() + '"')
host.rcon_invoke('admin.kickPlayer ' + str(i.index))
return
# if we checked everyone and only the commander remains... bye bye
if foundCommander == 1:
host.rcon_invoke('game.sayAll "' + scriptName + ': Player ' + commander.getName() + ' kicked for ' + aPlayer.getName() + '"')
host.rcon_invoke('admin.kickPlayer ' + str(commander.index))
else:
# no one to kick =(
#host.rcon_invoke('game.sayAll "' + scriptName + ': Player ' + aPlayer.getName() + ' kicked: no room even for people on the list!' + '"')
#host.rcon_invoke('admin.kickPlayer ' + str(aPlayer.index))
return

def changeMode(m):
global mode, knownPlayers, scriptName
if m == 'private':
host.rcon_invoke('game.sayAll "' + scriptName + ': Changing to private mode. Flushing the undesirables!"')
currPlayers=bf2.playerManager.getPlayers()
for i in currPlayers:
if not i.getName() in knownPlayers:
host.rcon_invoke('admin.kickPlayer ' + str(i.index))

mode=0
elif m == 'semiprivate':
host.rcon_invoke('game.sayAll "' + scriptName + ': Changing to semiprivate mode. Bring on some asshats!"')
mode=1
else:
host.rcon_invoke('game.sayAll "' + scriptName + ': Changing to public mode. Bring on the asshats!"')
mode=2

def addPlayerToList(aPlayerName):
global fileName, knownPlayers
if aPlayerName in knownPlayers:
print 'User already in list!'
return
playersFile = file(fileName, 'a')
playersFile.write(aPlayerName+'\n')
knownPlayers.append(aPlayerName)
print 'User added to list.'

def writeMode(ctx):
global mode
if (mode == 0):
ctx.write('The current mode is private.')
elif(mode == 1):
ctx.write('The current mode is semiprivate.')
else:
ctx.write('The current mode is public.')

def writeNumList(ctx):
global knownPlayers
playerCount=0
currPlayers=bf2.playerManager.getPlayers()
for i in currPlayers:
if i.getName() in knownPlayers:
playerCount=playerCount+1
ctx.write('There are %i players from the list online.' % (playerCount) )

def isOnList(player, ctx):
global knownPlayers
if player in knownPlayers:
ctx.write('Player ' + player + ' is registered on the list.')
else:
ctx.write('Player ' + player + ' is *not* on the list. Do what you must with him.')

def removePlayerFromList(aPlayerName):
global fileName, knownPlayers
if not aPlayerName in knownPlayers:
return
knownPlayers.remove(aPlayerName)
playersFile = file(fileName, 'w')
playersFile.truncate(0)
for aPlayer in knownPlayers:
playersFile.write(aPlayer+'\n')
playersFile.close()
</pre>

Now overwrite the default.py file in your admin folder with this.

default.py:

<pre>
# vim: ts=4 noexpandtab
#
# Battlefield II -- default remote console module.
#
# This is a very simple, TCP based remote console which does simple MD5 digest
# password authentication. It can be configured via the admin/default.cfg file.
# Recognized options are 'port' and 'password'.
#
# Implementation guidelines for this file (and for your own rcon modules):
#
# - All socket operations MUST be non-blocking. If your module blocks on a
# socket the game server will hang.
#
# - Do as little work as possible in update() as it runs in the server main
# loop.
#
# Other notes:
#
# - To get end-of-message markers (0x04 hex) after each reply, begin your
# commands with an ascii 0x02 code. This module will then append the
# end-of-message marker to all results. This is useful if you need to wait
# for a complete response.
#
# Copyright (c)2004 Digital Illusions CE AB
# Author: Andreas `dep' Fredriksson

import socket
import errno
import host
import bf2
import types
import md5
import string
import random
import standard_admin.kickoutsiders

options = {
'port': '4711',
'password': None,

# True if multiple commands should be processed in one update and
# if as many responses as possible should be sent each update.
'allowBatching': False
}

# Returns a seed string of random characters to be used as a salt to protect
# password sniffing.
def make_seed(seed_length):
return ''.join([string.ascii_letters[random.randint(0, len(string.ascii_letters)-1)] for x in xrange(0, seed_length)])

# Concats a seed string with the password and returns an ASCII-hex MD5 digest.
def digest(seed, pw):
if not pw: return None
m = md5.new()
m.update(seed)
m.update(pw)
return m.hexdigest()

# Parses the config file, if it's there
def parseConfig():
def boolFromString (str):
if str in ['True', 'true', '1']:
return True
elif value in ['False', 'false', '0']:
return False
else:
raise ValueError

fn = 'admin/default.cfg'
try:
config = open(fn, 'r')
lineNo = 0
for line in config:
lineNo += 1
if line.strip() != '' and line.strip() != '\n':
try:
(key, value) = line.split('=')
key = key.strip()
value = value.strip()

if key == 'allowBatching': value = boolFromString (value)
options[key] = value

except ValueError:
print 'warning: syntax error in "%s" on line %d' % (fn, lineNo)
except IOError, detail:
print 'warning: couldn\'t read "%s": %s' % (fn, detail)

# A stateful output buffer that knows how to enqueue data and ship it out
# without blocking.
class OutputBuffer(object):

def __init__(self, sock):
self.sock = sock
self.data = []
self.index = 0

def enqueue(self, str):
self.data.append(str)

def update(self):
allowBatching = options['allowBatching']
while len(self.data) > 0:
try:
item = self.data[0]
scount = self.sock.send(item[self.index:])
self.index += scount
if self.index == len(item):
del self.data[0]
self.index = 0
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
return detail[1]
if not allowBatching:
break
return None

# Each TCP connection is represented by an object of this class.
class AdminConnection(object):

def __init__(self, srv, sock, addr):
print 'new rcon/admin connection from %s:%d' % (addr[0], addr[1])
self.server = srv
self.sock = sock
self.addr = addr
self.sock.setblocking(0)
self.buffer = ''
self.seed = make_seed(16)
self.correct_digest = digest(self.seed, options['password'])
self.outbuf = OutputBuffer(self.sock)

# Welcome message *must* end with \n\n
self.outbuf.enqueue('### Battlefield 2 default RCON/admin ready.\n')
self.outbuf.enqueue('### Digest seed: %s\n' % (self.seed))
self.outbuf.enqueue('\n') # terminate welcome message with extra LF

def update(self):
err = None
try:
allowBatching = options['allowBatching']
while not err:
data = self.sock.recv(1024)
if data:
self.buffer += data
while not err:
nlpos = self.buffer.find('\n')
if nlpos != -1:
self.server.onRemoteCommand(self, self.buffer[0:nlpos])
self.buffer = self.buffer[nlpos+1:] # keep rest of buffer
else:
if len(self.buffer) > 128:
err = 'data format error: no newline in message'
break
if not allowBatching: break
else:
err = 'peer disconnected'

if not allowBatching: break

except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
err = detail[1]

if not err:
err = self.outbuf.update()

if err:
print 'rcon: closing %s:%d: %s' % (self.addr[0], self.addr[1], err)
try:
self.sock.shutdown(2)
self.sock.close()
except:
print 'rcon: warning: failed to close %s' % (self.addr)
pass
return 0
else:
return 1

# Context passed to remote command implementations for them to write output to
# either a remote tcp socket or an in-game client executing 'rcon <command>'.
class CommandContext(object):
def __init__(self):
self.player = None
self.socket = None
self.output = []

def isInGame(self): return self.player is not None
def isSocket(self): return self.socket is not None
def write(self, text): self.output.append(text)

# The server itself.
class AdminServer(object):

def __init__(self, port):
# state for tcp rcon connections
self.port = port
self.backlog = 1
self.peers = []
self.openSocket()

# state for in-game rcon connections
host.registerHandler('RemoteCommand', self.onRemoteCommand, 1)
host.registerHandler('PlayerDisconnect', self.onPlayerDisconnect, 1)
host.registerHandler('ChatMessage', self.onChatMessage, 1)

# contains player ids for players which have successfully authenticated
# themselves with 'rcon login <passwd>'
self.authed_players = {}
# contains sockets for connections which have successfully authenticated
# themselves with 'login <passwd>'
self.authed_sockets = {}

# rcon commands supported in this vanilla version
self.rcon_cmds = {
'login': self.rcmd_login,
'users': self.rcmd_users,
'exec': self.rcmd_exec,
'addPlayer': self.rcmd_addPlayer,
'removePlayer': self.rcmd_removePlayer,
'changeMode': self.rcmd_changeMode,
'currentMode': self.rcmd_currMode,
'numFromList': self.rcmd_numFromList,
'isOnList': self.rcmd_isOnList
}

# Called when a user types 'rcon ' followed by any string in a client
# console window or when a TCP client sends a complete line to be
# evaluated.
def onRemoteCommand(self, playerid_or_socket, cmd):
cmd = cmd.strip()
interactive = True

# Is this a non-interactive client?
if len(cmd) > 0 and cmd[0] == '\x02':
cmd = cmd[1:]
interactive = False

spacepos = cmd.find(' ')
if spacepos == -1: spacepos=len(cmd)
subcmd = cmd[0:spacepos]

ctx = CommandContext()
authed = 0
if type(playerid_or_socket) == types.IntType:
ctx.player = playerid_or_socket
authed = self.authed_players.has_key(ctx.player)
else:
ctx.socket = playerid_or_socket
authed = self.authed_sockets.has_key(ctx.socket)

# you can only login unless you are authenticated
if subcmd != 'login' and not authed:
ctx.write('error: not authenticated: you can only invoke \'login\'\n')
else:
if self.rcon_cmds.has_key(subcmd):
self.rcon_cmds[subcmd](ctx, cmd[spacepos+1:])
else:
ctx.write('unknown command: \'%s\'\n' % (subcmd))

feedback = ''.join(ctx.output)
if ctx.socket:
if interactive:
ctx.socket.outbuf.enqueue(feedback)
else:
ctx.socket.outbuf.enqueue(feedback + '\x04')
else:
host.rcon_feedback(ctx.player, feedback)

# When players disconnect, remove them from the auth map if they were
# authenticated so that the next user with the same id doesn't get rcon
# access.
def onPlayerDisconnect(self, player_id):
if self.authed_players.has_key(player_id):
del self.authed_players[player_id]

# Called whenever a player issues a chat string.
def onChatMessage(self, player_id, text, channel, flags):
print 'chat: pid=%d text=\'%s\' channel=%s' % (player_id, text, channel)

# Sets up the listening TCP RCON socket. This binds to 0.0.0.0, which may
# not be what you want but it's a sane default for most installations.
def openSocket(self):
try:
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, 0)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self.sock.bind(('0.0.0.0', self.port))
self.sock.listen(self.backlog)
self.sock.setblocking(0)
except socket.error, detail:
print 'failed to bind rcon socket--only in-game rcon will be enabled'

# WARNING: update is called very frequently -- don't go crazy with logic
# here.
def update(self):
# if we don't have a socket, just return
if not self.sock: return

# without blocking, check for new connections
try:
conn, peeraddr = self.sock.accept()
self.peers.append(AdminConnection(self, conn, peeraddr))
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
raise socket.error, detail

# update clients and mark connections that fail their update
disc = []
for client in self.peers:
if not client.update(): disc.append(client)

# delete any auth status for closed tcp connections
for d in disc:
if self.authed_sockets.has_key(d): del self.authed_sockets[d]

# now keep the remaining clients
self.peers = filter(lambda x: x not in disc, self.peers)

def shutdown(self):
if self.sock:
self.sock.close()

# Command implementations go here (member functions of the AdminServer)

# Allows a in-game rcon client to authenticate and get access.
def rcmd_login(self, ctx, cmd):
success = 0
if ctx.isInGame():
# We're called by an in-game rcon client, use plain-text password
# (encoded into bf2 network stream).
if cmd.strip() == options['password']:
self.authed_players[ctx.player] = 1
success = 1
elif self.authed_players.has_key(ctx.player):
del self.authed_players[ctx.player]
else:
# tcp client, require seeded digest to match instead of pw
if cmd.strip() == ctx.socket.correct_digest:
self.authed_sockets[ctx.socket] = 1
print 'rcon: tcp client from %s:%d logged on' % ctx.socket.addr
success = 1
else:
if self.authed_sockets.has_key(ctx.socket):
del self.authed_sockets[ctx.socket]
print 'rcon: tcp client from %s:%d failed pw challenge' % ctx.socket.addr

if success:
ctx.write('Authentication successful, rcon ready.\n')
else:
ctx.write('Authentication failed.\n')

# Lists rcon-authenticated players.
def rcmd_users(self, ctx, cmd):
ctx.write('active rcon users:\n')
for id in self.authed_players:
if id == -1:
ctx.write('-1 (local server console)\n')
else:
try:
player = bf2.playerManager.getPlayerByIndex(id)
ctx.write('%d from %s name=\'%s\'\n' % (id, player.getAddress(), player.getName()))
except:
ctx.write('%d (no info)\n' % (id))

for peer in self.authed_sockets:
ctx.write('tcp: %s:%d\n' % (peer.addr[0], peer.addr[1]))

# Executes a console command on the server.
def rcmd_exec(self, ctx, cmd):
ctx.write(host.rcon_invoke(cmd))

def rcmd_addPlayer(self, ctx, cmd):
ctx.write('Adding player ' + cmd)
standard_admin.kickoutsiders.addPlayerToList(cmd)

def rcmd_removePlayer(self, ctx, cmd):
ctx.write('Removing player ' + cmd)
standard_admin.kickoutsiders.removePlayerFromList(cmd)

def rcmd_changeMode(self, ctx, cmd):
standard_admin.kickoutsiders.changeMode(cmd)

def rcmd_currMode(self, ctx, cmd):
standard_admin.kickoutsiders.writeMode(ctx)

def rcmd_numFromList(self, ctx, cmd):
standard_admin.kickoutsiders.writeNumList(ctx)

def rcmd_isOnList(self, ctx, cmd):
standard_admin.kickoutsiders.isOnList(cmd, ctx)

# parse the configuration file
parseConfig()

# our single server instance
server = AdminServer(int(options['port']))

# These functions are called from the engine -- we implement them in terms of a
# class instance:

def init():
print 'initializing default admin/rcon module'

# load (optional) admin scripts like teamkill punish and autobalance
import standard_admin

def shutdown():
if server:
print 'shutting down default admin/rcon module'
server.shutdown()

def update():
if server: server.update()
</pre>
note from Milton: Wow this script seems to be really good, unfortunately I cannot test it because I am using BF2CC, do you think that you could modify the default.py that BF2CC has in order to make it so that we can use both BF2CC and your script?

note from Brian:I've adapted the script for the BF2CC app. Enjoy!

default.py

<pre>
# vim: ts=4 noexpandtab
#
# Battlefield II -- default remote console module.
#
# This is a very simple, TCP based remote console which does simple MD5 digest
# password authentication. It can be configured via the admin/default.cfg file.
# Recognized options are 'port' and 'password'.
#
# Implementation guidelines for this file (and for your own rcon modules):
#
# - All socket operations MUST be non-blocking. If your module blocks on a
# socket the game server will hang.
#
# - Do as little work as possible in update() as it runs in the server main
# loop.
#
# Other notes:
#
# - To get end-of-message markers (0x04 hex) after each reply, begin your
# commands with an ascii 0x02 code. This module will then append the
# end-of-message marker to all results. This is useful if you need to wait
# for a complete response.
#
# Copyright (c)2004 Digital Illusions CE AB
# Author: Andreas `dep' Fredriksson
#
# This version of this script is managed by the BF2CC crew.
#
# CHANGE LOG
# June 13 - Hooked in BF2CC.py file. Seperating BF2CC custom commands from EA's customs commands.
#
# June 25 - Added exception handlers for all functions.
# June 25 - Added python log file support for errors and 'print' statements in the python code. (redir of stdout) options - pythonlogfile
# June 25 - Added support for alternative IP binding. options - ip
#
# Version 3.5
# July 5 - Added some security related fixes
# July 5 - Added player rank into player list function

import socket
import errno
import host
import bf2
import types
import md5
import string
import random
import bf2cc # Added BF2CC June 13, 2005
import sys
import standard_admin.kickoutsiders

# Set these options in the default.cfg
options = {
'port': '4711',
'password': None,
'ip': '0.0.0.0', # Added BF2CC rbarone
'pythonlogfile': 'pythonlog.txt' # Added BF2CC rbarone
}

# Function added BF2CC rbarone
def printExceptionTrace(e, location):
# generate line number
lineNum = ''
execInfo = sys.exc_info()
tb = execInfo[2]
while tb is not None:
if lineNum == '':
lineNum = str(tb.tb_lineno)
else:
lineNum += ', ' + str(tb.tb_lineno)
tb = tb.tb_next

print('**** ERROR ERROR ERROR ****\n Exception generated in %s\n %s\n %s\n (Line(s): %s)\n' % (location, str(execInfo[0]), str(e), lineNum))
if options['pythonlogfile'] != '':
sys.stdout.flush()

# Returns a seed string of random characters to be used as a salt to protect
# password sniffing.
def make_seed(seed_length):
return ''.join([string.ascii_letters[random.randint(0, len(string.ascii_letters)-1)] for x in xrange(0, seed_length)])

# Concats a seed string with the password and returns an ASCII-hex MD5 digest.
def digest(seed, pw):
if not pw: return None
m = md5.new()
m.update(seed)
m.update(pw)
return m.hexdigest()

# Parses the config file, if it's there
def parseConfig():
def boolFromString (str):
if str in ['True', 'true', '1']:
return True
elif value in ['False', 'false', '0']:
return False
else:
raise ValueError

fn = 'admin/default.cfg'
try:
config = open(fn, 'r')
lineNo = 0
for line in config:
lineNo += 1
if line.strip() != '' and line.strip() != '\n':
try:
(key, value) = line.split('=')
key = key.strip()
value = value.strip()

#if key == 'allowBatching': value = boolFromString (value) # Removed BF2CC rbarone
options[key] = value

except ValueError:
print 'warning: syntax error in "%s" on line %d' % (fn, lineNo)
except IOError, detail:
print 'warning: couldn\'t read "%s": %s' % (fn, detail)
except Exception, e:
printExceptionTrace(e, 'parseConfig')

if options['pythonlogfile'] != '':
global stdoutFlushTimer

stdoutFlushTimer = bf2.Timer(onFlushStdout, 10, 1)
stdoutFlushTimer.setRecurring(10)

sys.stdout = file(options['pythonlogfile'], 'a')

def onFlushStdout(data):
try:
sys.stdout.flush()
except:
print 'could not flush'
pass

# A stateful output buffer that knows how to enqueue data and ship it out
# without blocking.
class OutputBuffer(object):
def __init__(self, sock):
self.sock = sock
self.data = []
self.index = 0

def enqueue(self, str):
try: # Added BF2CC rbaron
self.data.append(str)
except Exception, e:
printExceptionTrace(e, 'enqueue')

def update(self):
allowBatching = True # Changed BF2CC rbarone - Always set to true
while len(self.data) > 0:
try:
item = self.data[0]
scount = self.sock.send(item[self.index:])
self.index += scount
if self.index == len(item):
del self.data[0]
self.index = 0
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
return detail[1]
except Exception, e:
printExceptionTrace(e, 'OutputBuffer.update')

# if not allowBatching: # Removed BF2CC rbarone
# break
return None

# Each TCP connection is represented by an object of this class.
class AdminConnection(object):

def __init__(self, srv, sock, addr):
try:
print 'new rcon/admin connection from %s:%d' % (addr[0], addr[1])
self.server = srv
self.sock = sock
self.addr = addr
self.sock.setblocking(0)
self.buffer = ''
self.seed = make_seed(16)
self.correct_digest = digest(self.seed, options['password'])
self.outbuf = OutputBuffer(self.sock)

self.bf2ccClient = bf2cc.Client(srv.bf2ccServer) # Added BF2CC June 13, 2005 rbarone

# Welcome message *must* end with \n\n
self.outbuf.enqueue('### Battlefield 2 version ' + bf2cc.scriptVersion + ' ' + bf2cc.serverType + ' default RCON/admin ready.\n') # Changed BF2CC - Added script version rbarone
self.outbuf.enqueue('### Digest seed: %s\n' % (self.seed))
self.outbuf.enqueue('\n') # terminate welcome message with extra LF
except Exception, e:
printExceptionTrace(e, 'AdminConnection.__init__')

def update(self):
err = None
try:
allowBatching = True # Changed BF2CC - Always set to true
while not err:
data = self.sock.recv(1024)
if data:
self.buffer += data
while not err:
nlpos = self.buffer.find('\n')
if nlpos != -1:
self.server.onRemoteCommand(self, self.buffer[0:nlpos])
self.buffer = self.buffer[nlpos+1:] # keep rest of buffer
else:
if len(self.buffer) > 128:
err = 'data format error: no newline in message'
break
#if not allowBatching: break # Removed BF2CC rbarone
else:
err = 'peer disconnected'

#if not allowBatching: break #Removed BF2CC rbarone

except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
err = detail[1]
except Exception, e:
printExceptionTrace(e, 'AdminConnection.update')
err = 'Exception in AdminConnection.update'

try:

if not err:
err = self.outbuf.update()

if err:
print 'rcon: closing %s:%d: %s' % (self.addr[0], self.addr[1], err)
self.bf2ccClient.UnregisterClient() # Added BF2CC June 13, 2005 rbarone
try:
self.bf2ccClient = None
self.sock.shutdown(2)
self.sock.close()
except:
print 'rcon: warning: failed to close %s' % (self.addr)
pass
return 0
else:
return 1
except Exception, e:
printExceptionTrace(e, 'AdminConnection.update')
err = 'Exception in AdminConnection.update'

# Context passed to remote command implementations for them to write output to
# either a remote tcp socket or an in-game client executing 'rcon <command>'.
class CommandContext(object):
def __init__(self):
self.player = None
self.socket = None
self.output = []

def isInGame(self): return self.player is not None
def isSocket(self): return self.socket is not None
def write(self, text): self.output.append(text)

# The server itself.
class AdminServer(object):

def __init__(self, port):
try:
# state for tcp rcon connections
self.port = port
self.backlog = 1
self.peers = []
self.openSocket()

# state for in-game rcon connections
host.registerHandler('RemoteCommand', self.onRemoteCommand, 1)
host.registerHandler('PlayerDisconnect', self.onPlayerDisconnect, 1)
host.registerHandler('ChatMessage', self.onChatMessage, 1)

# contains player ids for players which have successfully authenticated
# themselves with 'rcon login <passwd>'
self.authed_players = {}
# contains sockets for connections which have successfully authenticated
# themselves with 'login <passwd>'
self.authed_sockets = {}

# rcon commands supported in this vanilla version
self.rcon_cmds = {
'login': self.rcmd_login,
'users': self.rcmd_users,
'exec': self.rcmd_exec,
'bf2cc': self.rcmd_bf2cc,
'addPlayer': self.rcmd_addPlayer,
'removePlayer': self.rcmd_removePlayer,
'changeMode': self.rcmd_changeMode,
'currMode': self.rcmd_currMode,
'numFromList': self.rcmd_numFromList,
'isOnList': self.rcmd_isOnList,
}

self.bf2ccServer = bf2cc.Server(self) # Added BF2CC June 13, 2005
#self.bf2ccServer.RegisterServer(self) # Added BF2CC June 13, 2005
except Exception, e:
printExceptionTrace(e, 'AdminServer.__init__')
raise e

# Called when a user types 'rcon ' followed by any string in a client
# console window or when a TCP client sends a complete line to be
# evaluated.
def onRemoteCommand(self, playerid_or_socket, cmd):
try:
cmd = cmd.strip()
interactive = True

# Is this a non-interactive client?
if len(cmd) > 0 and cmd[0] == '\x02':
cmd = cmd[1:]
interactive = False

spacepos = cmd.find(' ')
if spacepos == -1: spacepos=len(cmd)
subcmd = cmd[0:spacepos]

ctx = CommandContext()
authed = 0
if type(playerid_or_socket) == types.IntType:
ctx.player = playerid_or_socket
authed = self.authed_players.has_key(ctx.player)
else:
ctx.socket = playerid_or_socket
authed = self.authed_sockets.has_key(ctx.socket)

# you can only login unless you are authenticated
if subcmd != 'login' and not authed:
ctx.write('error: not authenticated: you can only invoke \'login\'\n')
else:
if self.rcon_cmds.has_key(subcmd):
self.rcon_cmds[subcmd](ctx, cmd[spacepos+1:])
else:
ctx.write('unknown command: \'%s\'\n' % (subcmd))

feedback = ''.join(ctx.output)
if ctx.socket:
if interactive:
ctx.socket.outbuf.enqueue(feedback)
else:
ctx.socket.outbuf.enqueue(feedback + '\x04')
else:
host.rcon_feedback(ctx.player, feedback)
except Exception, e:
printExceptionTrace(e, 'AdminServer.onRemoteCommand')

# When players disconnect, remove them from the auth map if they were
# authenticated so that the next user with the same id doesn't get rcon
# access.
def onPlayerDisconnect(self, player):
try:
if self.authed_players.has_key(player.index):
print('Removing PlayerID: %s' % str(player.index))
del self.authed_players[player.index]
except Exception, e:
printExceptionTrace(e, 'AdminServer.onPlayerDisconnect')

# Called whenever a player issues a chat string.
def onChatMessage(self, player_id, text, channel, flags):
try:
print 'chat: pid=%d text=\'%s\' channel=%s' % (player_id, text, channel)
except Exception, e:
printExceptionTrace(e, 'AdminServer.onChatMessage')

# Sets up the listening TCP RCON socket. This binds to 0.0.0.0, which may
# not be what you want but it's a sane default for most installations.
def openSocket(self):
try:
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, 0)
#self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self.sock.bind((options['ip'], self.port))
self.sock.listen(self.backlog)
self.sock.setblocking(0)
except socket.error, detail:
print 'failed to bind rcon socket. Check the IP and port configured, it may be in use by another program.'
self.sock = None
except Exception, e:
printExceptionTrace(e, 'AdminServer.openSocket')

# WARNING: update is called very frequently -- don't go crazy with logic
# here.
def update(self):
try:
# if we don't have a socket, just return
if not self.sock: return

# without blocking, check for new connections
try:
conn, peeraddr = self.sock.accept()
self.peers.append(AdminConnection(self, conn, peeraddr))
except socket.error, detail:
if detail[0] != errno.EWOULDBLOCK:
raise socket.error, detail

# update clients and mark connections that fail their update
disc = []
for client in self.peers:
if not client.update(): disc.append(client)

# delete any auth status for closed tcp connections
for d in disc:
if self.authed_sockets.has_key(d): del self.authed_sockets[d]

# now keep the remaining clients
self.peers = filter(lambda x: x not in disc, self.peers)
except Exception, e:
printExceptionTrace(e, 'AdminServer.update')

def shutdown(self):
try:
if self.sock:
self.sock.close()
except Exception, e:
printExceptionTrace(e, 'AdminServer.shutdown')

# Command implementations go here (member functions of the AdminServer)

# Allows a in-game rcon client to authenticate and get access.
def rcmd_login(self, ctx, cmd):
try:
success = 0
if ctx.isInGame():
# We're called by an in-game rcon client, use plain-text password
# (encoded into bf2 network stream).
if cmd.strip() == options['password']:
self.authed_players[ctx.player] = 1
success = 1
print 'rcon: in-game client, player id: %s authenticated' % str(ctx.player)
elif self.authed_players.has_key(ctx.player):
del self.authed_players[ctx.player]
else:
# tcp client, require seeded digest to match instead of pw
if cmd.strip() == ctx.socket.correct_digest:
self.authed_sockets[ctx.socket] = 1
print 'rcon: tcp client from %s:%d logged on' % ctx.socket.addr
success = 1
else:
if self.authed_sockets.has_key(ctx.socket):
del self.authed_sockets[ctx.socket]
print 'rcon: tcp client from %s:%d failed pw challenge' % ctx.socket.addr

if success:
if ctx.isSocket(): # Added BF2CC June 13, 2005
ctx.socket.bf2ccClient.RegisterClient(ctx.socket) # Added BF2CC June 13, 2005

ctx.write('Authentication successful, rcon ready.\n')
else:
ctx.write('Authentication failed.\n')
except Exception, e:
printExceptionTrace(e, 'AdminServer.rcmd_login')

# Lists rcon-authenticated players.
def rcmd_users(self, ctx, cmd):
try:
ctx.write('active rcon users:\n')
for id in self.authed_players:
if id == -1:
ctx.write('-1 (local server console)\n')
else:
try:
player = bf2.playerManager.getPlayerByIndex(id)
ctx.write('%d from %s name=\'%s\'\n' % (id, player.getAddress(), player.getName()))
except:
ctx.write('%d (no info)\n' % (id))

for peer in self.authed_sockets:
ctx.write('tcp: %s:%d\n' % (peer.addr[0], peer.addr[1]))
except Exception, e:
printExceptionTrace(e, 'AdminServer.rcmd_users')

# Executes a console command on the server.
def rcmd_exec(self, ctx, cmd):
try:
ctx.write(host.rcon_invoke(cmd))
except Exception, e:
printExceptionTrace(e, 'AdminServer.rcmd_exec')

# Executes a bf2cc command on the server. Added BF2CC June 13, 2005
def rcmd_bf2cc(self, ctx, cmd): # Added BF2CC June 13, 2005
try:
ctx.socket.bf2ccClient.Exec(ctx, cmd) # Added BF2CC June 13, 2005
except Exception, e:
printExceptionTrace(e, 'AdminServer.rcmd_bf2cc')

def rcmd_addPlayer(self, ctx, cmd):
ctx.write('Adding player ' + cmd)
standard_admin.kickoutsiders.addPlayerToList(cmd)

def rcmd_removePlayer(self, ctx, cmd):
ctx.write('Removing player ' + cmd)
standard_admin.kickoutsiders.removePlayerFromList(cmd)

def rcmd_changeMode(self, ctx, cmd):
standard_admin.kickoutsiders.changeMode(cmd)

def rcmd_currMode(self, ctx, cmd):
standard_admin.kickoutsiders.writeMode(ctx)

def rcmd_numFromList(self, ctx, cmd):
standard_admin.kickoutsiders.writeNumList(ctx)

def rcmd_isOnList(self, ctx, cmd):
standard_admin.kickoutsiders.isOnList(cmd, ctx)

# parse the configuration file
parseConfig()

# our single server instance
server = AdminServer(int(options['port']))

# These functions are called from the engine -- we implement them in terms of a
# class instance:

def init():
print 'initializing default admin/rcon module'

try:
# load (optional) admin scripts like teamkill punish and autobalance
import standard_admin
except Exception, e:
printExceptionTrace(e, 'default.py.init')

def shutdown():
if server:
print 'shutting down default admin/rcon module'
server.shutdown()

def update():
if server: server.update()
</pre>

Scripts:ReservedSlots

2018-06-22T15:22:58Z

Pireax: Created page with "A small script to make sure there will always be a few reserved slots for certain players. If a non approved nick logs on and the server has reached its limit, that player wil..."

A small script to make sure there will always be a few reserved slots for certain players. If a non approved nick logs on and the server has reached its limit, that player will be kicked immediately.

This script should be run as the autobalance.py and tk_punish.py scripts in the standard_admin folder, which means change the __init__.py file to include this script.

The script is very simple, but works well. Later I might add useful bits, like not having to modify the script to approve players or change the player threshold. Also I might change the player threshold to be more dynamic, not counting approved players in the total.

In its current form below, the nicks PLAYER1, PLAYER2 and PLAYER3 will be the only people allowed on the server once 24 players are already present.

<code> </code>

<code> </code><pre>
# Reserved slots system for Battlefield 2
# Martin Ostergaard <monstergod@gmail.com> - 2005

import bf2
import host
from bf2 import g_debug

APPROVED_PLAYERS = ['PLAYER1', 'PLAYER2', 'PLAYER3']
MAX_PLAYERS = 24

def init():
host.registerHandler('PlayerConnect', resPlayerConnect, 1)
host.registerHandler('PlayerDeath', resPlayerDeath, 1)#Added by Milton

def resPlayerConnect(p):
ONLINEPLAYERS = len(bf2.playerManager.getPlayers())

if ONLINEPLAYERS > MAX_PLAYERS:
if APPROVED_PLAYERS.count(p.getName()) < 1:
host.rcon_invoke('admin.kickPlayer ' + str(p.index))
</pre>

# Added by Milton

<pre>
def resPlayerDeath(p, vehicle):
ONLINEPLAYERS = len(bf2.playerManager.getPlayers())
name = p.getName()
if ONLINEPLAYERS > MAX_PLAYERS:
if APPROVED_PLAYERS.count(p.getName()) < 1:
host.rcon_invoke('PB_SV_Kick ' + name + ' 0 Sorry, making room for members')
return
</pre>

<code></code>

Note from underplay: Im busy right now, but it wouldnt be a bad idea to check to see if the approved players are already in the server..if they are all present, allow players to connect.

Note from monsterdog: Very nice idea, and I have already changed the running version of it substantially, for instance I have added the capability to change the approved list in runtime. I will edit the script on these pages to reflect that once I'm sure it runs smoothly.

Note from bS: I like the idea of this script, one suggestion though. If you just setup one slot as permanently free? ea. you have a 32 player server and make it 33 slots. A player could always connect to the 33rd slot, when this happens an unapproved player would be kicked stating that he connected to a reserved slot; an approved player however will cause the script to kick an unapproved player who is already on the server and thus opening a new reserved slot to repeat the procedure in the future.

Note from Mugzy: How about using a punkbuster kick so the kicked person can see why they were kicked?

Note from Milton: In reply to bS, I modified it a bit so that it does exactly that, when an approved player joins the next person to die that is not approved gets kicked, however the punkbuster kick will not work right as the person joins, unfortunately it seems punkbuster doesn't recognize them untill they get into the server

Note from monsterdog: Also the PB kick appearantly lags the server a bit everytime someone is kicked. I am deliberately putting off playing more with this script until patch 1.03 is out, where it is reportedly possible to kick with a specific message popping up over the server browser. I have an updated version of the script, however, which will let you change the approved list while the server is still running:

<code> </code>

<code> </code><pre>
# Reserved slots system for Battlefield 2
# Martin Ostergaard - 2005

import bf2
import host
import sys
from bf2 import g_debug

CONFIG_FILE = '/home/bf2user/bf2/admin/standard_admin/approved_players.cfg'
MAX_PLAYERS = 20

def init():
print 'initializing reserved slots script'
host.registerHandler('PlayerConnect', resPlayerConnect, 1)
sys.stdout.flush()

def resPlayerConnect(p):
onlineplayers = len(bf2.playerManager.getPlayers())
new_player = p.getName()

print new_player + ' connected, checking for a free slot'

if onlineplayers > MAX_PLAYERS:
print 'unreserved player max reached, checking if ' + new_player + ' is approved'

CONFIG_FD = open(CONFIG_FILE)
APPROVED_PLAYERS = CONFIG_FD.read()
CONFIG_FD.close()

if APPROVED_PLAYERS.count(new_player) > 0:
print new_player + ' approved for login'
else:
print new_player + ' not approved, will be kicked'
host.rcon_invoke('admin.kickPlayer ' + str(p.index))

sys.stdout.flush()
</pre>

<code></code>

The "approved_players.cfg" is simply a text file, with each players nick on a line by itself, like this:

<code> </code>

<code> </code><pre>
PLAYER_1
PLAYER_2
PLAYER_N
</pre>

<code></code>

Make sure you do not add any empty lines or extra stuff in there. I am pretty certain it will still work if you apply Milton's changes to it. Also note that it actually sends some debugging information out, if you have enabled some kind of error outputting.

Note by monsterdog: OK the above was a bit redundant, saw the new reserved slots script posted on this site, which basically does almost everything I had planned to do, very nice, use that instead :-)

Scripts

2018-06-22T15:22:11Z

Pireax: Created page with "Please add your scripts to this list for others to see, use and get inspiration from: __TOC__ == Access == ; Scripts:ReservedSlots|Always Keep Slots Free for Special Pl..."

Please add your scripts to this list for others to see, use and get inspiration from:

__TOC__

== Access ==

; [[Scripts:ReservedSlots|Always Keep Slots Free for Special Players]] (by monsterdog)
: When server reaches a certain number of players online, kick new players immediately unless they appear in an approved list.

; [[Scripts:ReserveSlots|A Better Reserved Slots System]] (by Solarius)
: Uses a dynamic list of players (stored in a text file) to give certain players priority-- kicking people not on the list to make room (and kicking commanders/squad leaders as a last option).

; [[Scripts:CountryFilter|CountryFilter]] (by Guwashi from [http://d3.jpn.org/ d3.jpn.org])
: Provides access control (allow/deny) based on player's country name.

; [[Scripts:IdleKick|Kick Players Who Are Idle for a Configurable Time]] (by Xlr8or from [http://www.xlr8or.com/ www.xlr8or.com])
: Checks if players are actually playing or not. Warns once and then kicks them to free the slot.

; [[Scripts:Kicking_for_high_ping|Kicking for High Ping]] (by Panic and Kybber from [http://www.battlefield.no/ Battlefield.no])
: Kicks high-pingers, based on a set of rules.

== Administration ==

; [[Scripts:dc_ass|Administrative Support System]] (by Butter from [http://dontcamp.com/ DontCamp.com])
: Provides an in-game chat based admin system similar to Kevin Lockitt's Battlefield Server Manager.

; [[Scripts:Automatic_Announcements|Automatic Announcements]] (by Woody)
: Makes automatic periodic announcements to all players.

; [[Scripts:AutoShutdown|Automatically Shutdown Server at Maintenance Time]] (by Greeze)
: A quick-and-dirty auto-shutdown script. Warns users at intervals before shutting down, and provides an option to either pause the game or quit the server.

; [[Scripts:BadWords|Automatically Kick Players for Using Banned Words]] (by Woody)
: Automatically kicks players who use "inappropriate" language in chat messages, or in their player names.

; [[Scripts:RconMap|Easily Change Map Through RCon]] (by biomass from [http://www.baconmen.net/ Clan BaconMen])
: Rcon 'map' command to easily change maps on a server.

; [[Scripts:RconCfg|Execute Commands from File]] (by truppo from [http://www.baconmen.net/ Clan BaconMen])
: Rcon 'cfg' command to execute commands from file.

; [[Scripts:BF2Admin|In-Game Administration Manager]] (by Danni)
: Provides the ability to flag users as administrators with varying levels of permissions. Help wanted!

; [[Scripts:TXT_File_base_Automatic_Announcements|TXT File-Based Automatic Announcements]] (by daveml)
: Makes automatic periodic announcements to all players listed in a text file. Thanks to Woody for planting the seed :)

== Gameplay ==

; [[Scripts:AntiBaseRape|Anti-Base Rape]] (by SHAnders)
: Punishes player attacking a team within a specified radius of their uncaptuable controlpoint.
: The script is also available in Modmanager [[Scripts:AntiBaseRapeMM|format]] for bf2cc users. (by graag42)

; [[Scripts:AutoMap|Automatic Map Changer/Randomizer]] (by dst from [http://dontcamp.com/ DontCamp.com])
: Automatically resizes maps based on players connected and randomizes the map cycle.

; [[Scripts:Autoteam_by_Tickets|Autoteam by Ticket Ratio]] (by dst from [http://dontcamp.com/ DontCamp.com])
: Automatically adjusts sv.teamRatioPercent in inverse proportion to the ticket ratio.

; [http://dev.vikingmind.com/c4punish c4punish](by BlackYoda from [http://www.vikingmind.com/ vikingmind.com])
: CTF game play mode add on to punish players who use C4 or Claymore mines near the main base flag. This script can be integrated with any CTF style Battlefield II gameplay mode, and is available now for Desert Conflict.

; [[Scripts:SquadlessKick|Kick Squadless Players]] (by Sarc)
: Kicks players that are not commanding or in a squad. Performs the check on player spawn.

; [[Scripts:MM_MapAutoSizer|ModManager Automatic Map Sizer]] (by [http://www.gloryhoundz.com/ GloryHoundz.com])
: This [ModManager ModManager] script will maintain the normal map rotation, but size the next map in rotation based on the number of players on the server.

; [[Scripts:OfftimePy|OfftimePy]] (by [User:Dackz Dackz])
: Gives the ability to have seperate settings for when there are and aren't enough people to start a game.

; [[Scripts:ClanTkProtection|Prevent Users from Punishing Your Clan Members]] (by underplay)
: Modifies the default tk punish script and prevents any members of your squad from being punished.

; [http://www.filecloud.com/files/file.php?user_file_id=36666 Remove Flags on 64 Player Maps Based on Player Count] (by FBX)
: This script will remove some of the flags on all of the 64 player maps that have planes based on the number of players currently in the server. For example, if 20 people are playing, 3 flags may be removed depending on the map. If 40 people are playing maybe only 1 of the flags are removed. If 64 people are playing, none of the flags are removed. Please edit the script before using to accomodate your server. If you are running a map as the 32 or 16 player version and not the 64 player, you'll want to be sure to disable it in the script. Overwrites the old rules for conquest, so make a back-up first. Installing doesnt affect play outside your server and is server-side only.

; [[Scripts:ThreatAndWorth|Threat and Worth]] (by SHAnders)
: Giving players bonus score based uppon a calculation of killer/vehicle worth vs victim/vehicle worth, overall threat rating and each players survival rating.

; [[Scripts:BF2Oldschool|Weapon Restriction and Commander Detection (BF2 Oldschool infantry script)]] (by MisiekBest)
: This infantry script can: restrict some weapons on server (medics only, medics only with no unlocks, knife-pistol-shockpaddles only, no unlocks, no c4, no claymore, no mgs, no tow), kick or kill player for using restricted weapons, detect and kick commander (or just throw info). You can also manage script via rcon.

; [[Scripts:Vehicle_Class_Limit|Vehicle Class Limit]] (by graag42)
: Prevents use of certain vehicle classes.

; [[Scripts:Aircraft_Only|Aircraft Only]] (by polarity from [http://flightschool.polar-lights.org.uk/ Coop Flight School])
: Based on the above Vehicle Class Limit, this script is used to 'persuade' all the players on the Coop Flight School server to play in aircraft only. Players who exit an aircraft they are spawned into are warned that they will start to take damage if they don't return to an aircraft in 25s. If they spawned outside an aircraft they are also warned to enter an aircraft. Prevents attempts to counter the damage by increasing damage rate if healing has occured.

== Miscellaneous ==

; [[Scripts:ConParser|ConParser]] (by FiRe- from [http://www.flmod.com/ flmod.com])
: A simple script to read and write BF-style Con-files.

; [[Scripts:EvalPy|EvalPy]] (by Dackz)
: Allows evaluation of python statements over RCON in the context of the RCON script.

; [[Scripts:EventsPy|EventsPy]] (by Dackz)
: Prints connection, disconnection, and chat events to the server console.

; [[Scripts:PostUrl|Posting URL Lib]] (by MPUKBoffbowsh from [http://www.multiplay.co.uk/ Multiplay UK])
: Gives ability to HTTP POST a number of fields to a web page. Currently receives a garbled response, need to fix that.

; [[Scripts:ReadingClanmembers|Reads Clanmembers from a File]] (by Nexus2k from [http://www.bs-dc.com/ bs-dc.com])
: Scriptpart for reading Clanmembers out of a members.cfg file

; [[Scripts:UDP_Based_Advert_System|UDP-Based Advert System]] (by Panic and Kybber from [http://www.battlefield.no/ Battlefield.no])
: An idea of how one could utilize sockets to create an UDP based advert system.

; [[Scripts:Player_Position_Display|Player Position Display]] (by polarity from [http://flightschool.polar-lights.org.uk/ Coop Flight School])
: For use as a tool when server side modding that can help with the positioning of vehicles/flags/spawn points. Displays the player's position and the direction that they're facing, in the same format as is used in the GamePlayObjects.con file.

== Modified Default Scripts ==

; [[Scripts:Enhanced_rotate_demo|Enhanced rotate_demo]] (by daveml)
: Additional logging for troubleshooting FTP, includes changes by dackz.

; [http://www.filecloud.com/files/file.php?user_file_id=36152 Enhanced TK Script] (by FBX, McAfee)
: powerful TK script designed to replace the original (however keep a back up of the original anyways). Allows limiting of punishing from "static" weapons, such as AT mines, artillery, and claymores, and removal of punishing from heat seeking weapons, which are difficult to TK with intentially. Additionally, players can earn off punishings on their record by getting kills, or can instead use McAfee's system which only allows you to punish and allow a certain number of times you can be punished based on the number of kills you have. The amount of punishing on your record you have recieved resets at the end of a round. Script is by default silent. Installing doesnt affect online play outside your server and is server-side only.
: The script is also available in Modmanager [[Scripts:Enhanced_TK_Script_in_ModManager_format|format]] for bf2cc users. (by graag42)

; [[Scripts:Modified_admin_script|Modified Admin Script ('default.py')]] (by Panic and Kybber from [http://www.battlefield.no/ Battlefield.no])
: Enables logging to file and udp, and loads a settings file from the directory where the maplist is loaded from.

; [[Scripts:ClanmemberBalance|Modified Autobalance Script]] (by Nexus2k from [http://www.bs-dc.com/ bs-dc.com])
: Prevents Clanmembers/Squadleaders/Commanders from Autobalance

; [[Scripts:ModifiedDemoRotator|Modified Demo Rotator]] (by Dackz)
: Fixes moving to and from the same place causing problems, and chmods all demo files 0644 so they are web-readable.

; [[Scripts:TK_punish_announcer|TK punish drop-in replacement]] (by Nadar, Kybber and Panic from [http://www.battlefield.no/ Battlefield.no])
: Announces the number of PTKs and FTKs a person has to prevent PTK-abuse. Does not modify the functionality of the original script, so it should be accepted as Ranked-server compatible.

== Restart Server Scripts ==

; [[Scripts:RestartScript|Restart Scripts]]
: Scripts To restart Your Server after Crash. --DarkPepe 18:38, 3 June 2006 (MDT)