HLSW Config Changes

From HLSW Wiki

In this article changes to the HLSW Config Files like new addons/plugins or games can be made.
If you add a new game and would like to provide a game icon for it, please upload it to any webspace and just link the icon here.
The icon should be at least have a size of 16x16 pixel and saved as an icon in the *.ico fileformat.
Changes, which are included in a new hlsw version will be moved to page Approved HLSW Config Changes.

Contents 1 AddOns.cfg 1.1 Stalker 1.2 HL2/CSS 2 Games.cfg and Query.cfg 2.1 Unreal Tournament 3 2.2 Call of Duty 4 2.3 Call of Duty 2 2.4 Call of Duty 1 2.5 Call of Duty UO 2.6 Quake 3 Challenge Pro Mode Arena 2.7 Enemy Territory: Quake Wars (Updated) 2.8 Quake 4 2.9 Doom 3 2.10 Prey 3 ParamList.cfg 4 Rcon.cfg 4.1 Call of Duty 1&2 4.2 Doom 3 Engine based games 4.2.1 Doom 3 4.2.2 ETQW 4.2.3 Quake 4 4.2.4 Prey 5 Games.cfg (Delayed) 5.1 Vietcong (better support)

AddOns.cfg

Stalker

• Detects Battleeye

		[] = {
			['Type'] = 'AntiCheatTool';
			['Name'] = 'BE';
			['LongName'] = 'BattlEye';
			['URL'] = 'http://wiki.hlsw.org/index.php/BattlEye Anti-Cheat';
			['ActiveRule'] = 'use_battleye';
		};

HL2/CSS

• Detects ServerWiper

		[] = {
			['Type'] = 'AddOn';
			['Name'] = 'SW';
			['LongName'] = 'ServerWiper';
			['VerRule'] = 'sw_version';
			['URL'] = 'http://wiki.hlsw.org/index.php/ServerWiper';
		};

Games.cfg and Query.cfg

Unreal Tournament 3

• Detects the full & demo version of the game

		['InstallPathKeys'] = {
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\{BFA90209-7AFF-4DB6-8E4B-E57305751AD7}\InstallLocation';
				['FileName'] = 'UT3.exe';
			};
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Installer\UserData\S-1-5-18\Products\9AEF66239E89B8442B53AD6CD3C47E18\InstallProperties\InstallLocation';
				['FileName'] = 'UT3Demo.exe';
			};
		};

Call of Duty 4

• Detects Zombie mod and Openwarfare mod

			['mods/zomdb'] = {
				['Name'] = 'Zombie';
			};
			['mods/openwarfare'] = {
				['Name'] = 'OpenWarfare';
			};
			['mods/promod'] = {
				['Name'] = 'ProMod';
			};

• Skip Mod switching ingame

['Parameter'] = {
	['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
};

Call of Duty 2

• Skip Mod switching ingame

['Parameter'] = {
	['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
};

Call of Duty 1

• Skip Mod switching ingame

['Parameter'] = {
	['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
};

Call of Duty UO

• Skip Mod switching ingame

['Parameter'] = {
	['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
};

Quake 3 Challenge Pro Mode Arena

• Adds Quake 3 Challenge Pro Mode Arena (modified version of Quake 3 Arena)
• Test Server: 85.14.220.222:27960

Query.cfg

	['Q3'] = {
		['Version'] = {
			['CNQ3'] = {
				['Game'] = 'CNQ3';
				['ChangeDir']['cpma'] = '';
			};
		};
	};

Games.cfg

	['_Custom:CNQ3'] = {
		['Name'] = 'Quake 3 Challenge Pro Mode Arena';
		['URL'] = 'http://wiki.hlsw.org/index.php/Quake_3_Arena';

		['InstallPathKeys'] = {
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\SOFTWARE\Id\Quake III Arena\INSTALLPATH';
				['FileName'] = 'cnq3.exe';
			};
		};
		['DefaultFileName'] = 'cnq3.exe';
		['NoModGameDir'] = 'cpma';

		['ConnectType'] = 'Parameter';
		['Parameter'] = {
			['List'] = 'Q3';

			['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
			['Password'] = vector('+set', 'password', '<PASSWORD>');
			['Connect'] = vector('+connect', '<CONNECTADDRPORT>');
			['Name'] = vector('+name', '<PLAYERNAME>');
		};

		['MapList'] = {
			['Extension'] = 'bsp';
			['Type'] = 'PK3';
		};

		['PlayerName'] = {
			['File'] = 'q3config.cfg';
			['Type'] = '3Param';
			['Param'] = 'seta name';
		};

		['Query'] = {
			['RconData'] = 'Q3';

			['LAN'] = {
				['DefaultQueryPort'] = 27960;
				['Protocol'] = 'Q3';
			};

			['Protocol'] = {
				[] = {
					['Protocol'] = 'Q3';
					['Condition'] = 'None';
				};
			};
		};

		['Flags'] = set('Connect', 'GamersSearch');

		['IconName'] = 'GameType_Q3';
	};

Enemy Territory: Quake Wars (Updated)

• Better ETQW support for HLSW

	['ETQW'] = {
		['Name'] = 'Enemy Territory: Quake Wars';
		['URL'] = 'http://wiki.hlsw.org/index.php/Enemy Territory:_Quake_Wars';

		['InstallPathKeys'] = {
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\SOFTWARE\Id\ET - QUAKE Wars\InstallPath';
				['FileName'] = 'etqw.exe';
			};
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\SOFTWARE\Id\ETQW Demo\InstallPath';
				['FileName'] = 'etqw.exe';
			};
		};
		['DefaultFileName'] = 'etqw.exe';

		['ConnectType'] = 'Parameter';
		['Parameter'] = {
			['Default'] = '+set com_allowconsole 1';
			['List'] = 'Doom3';
			['AccountValues'] = 3;
			['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
			['Password'] = vector('+set', 'password', '<PASSWORD>');
			['Connect'] = vector('+set', 'net_autoConnectServer', '<CONNECTADDRPORT>');
			['Name'] = vector('+set', 'ui_name', '<PLAYERNAME>');

			['Account'] = vector('+set', 'net_accountName', '<ACCOUTNAME>', '+set', 'net_accountPassword', '<ACCOUNTPASSWORD>');

		};

		['Mods'] = {
			[''] = {
				['Name'] = 'Original';
			};
			['etqwpro'] = {
				['Name'] = 'ETQW Pro';
			};
		};

		['MapList'] = {
			['Extension'] = 'entities';
			['Type'] = 'PK4';
		};
		['AddOns'] = 'ETQW';

		['Query'] = {
			['RconData'] = 'D3';

			['LAN'] = {
				['DefaultQueryPort'] = 27733;
				['Protocol'] = 'D3';
			};

			['Protocol'] = {
				[] = {
					['Protocol'] = 'Doom3';
					['Condition'] = 'None';
				};
			};
		};

		['Flags'] = set('Connect', 'GamersSearch');

		['IconName'] = 'GameType_ETQW';
	};

Quake 4

• Skip Mod switching ingame

		['Parameter'] = {
			['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
		};

Doom 3

• Skip Mod switching ingame
• Detects LMS Mod (http://lms.d3files.com/)

		['Parameter'] = {
			['Game'] = vector('+set', 'fs_game', '<GAMEDIR>');
		};

		['Mods'] = {
			[''] = {
				['Name'] = 'Original';
			};
			['emz'] = {
				['Name'] = 'The Enhanced Militarized Zone';
			};
			['lms4'] = {
				['Name'] = 'Last Man Standing Coop';
			};
		};

Prey

• Corrects default port

		['Query'] = {
			['LAN'] = {
				['DefaultQueryPort'] = 27719;
				['Protocol'] = 'D3';
			};
		};

ParamList.cfg

Rcon.cfg

Call of Duty 1&2

• Allows to send private messages

	['PlayerRightClickMenu'] = {
			[] = {
				['Text'] = 'Private Message';
				['Command'] = 'tell <PLAYERSLOT> "<INPUT:Enter private message (no one else can read this message):>"';
			};
	};

Doom 3 Engine based games

• Better support of these Games
• List of map commands corrected (needs adjustment by a developer)

Doom 3

	['D3'] = {
		['RconProtocol'] = 'D3';

		['bRconQueue'] = true;
		['bSecondPortRcon'] = false;
		['bBanIP'] = true;
		['bBanID'] = false;
		['bBanTime'] = false;
		['bBanSave'] = false;
		['bUsername'] = false;
		['bExtraPort'] = false;
		['bUTF8'] = false;

		['PermBanTime'] = '';
		['BanTimeMult'] = 1;

		['Command'] = {
			['test'] = 'echo HLSW: Test';
			['say'] = 'say "<ARG>"';
			['listplayers'] = 'status';
			['listmaps'] = 'dir maps/game/mp .map';
			['changemap'] = "si_map <ARG>\nNextMap";
			['kick'] = 'gamekick "<PLAYERNAME>"';
			['connectpassword:get'] = 'g_password';
			['connectpassword:set'] = "g_password  \"<ARG>\"\nsi_usepass 1";
			['rconpassword:get'] = 'net_serverRemoteConsolePassword';
			['rconpassword:set'] = 'net_serverRemoteConsolePassword  "<ARG>"';
		};
	};

ETQW

	['ETQW'] = {
		['RconProtocol'] = 'D3';

		['bRconQueue'] = true;
		['bSecondPortRcon'] = false;
		['bBanIP'] = true;
		['bBanID'] = false;
		['bBanTime'] = false;
		['bBanSave'] = false;
		['bUsername'] = false;
		['bExtraPort'] = false;
		['bUTF8'] = false;

		['PermBanTime'] = '';
		['BanTimeMult'] = 1;

		['Command'] = {
			['test'] = 'echo HLSW: Test';
			['say'] = 'say "<ARG>"';
			['listplayers'] = 'status';
			['listmaps'] = 'dir maps .entities';
			['changemap'] = "spawnserver <ARG>";
			['kick'] = 'gamekick "<PLAYERNAME>"';
			['connectpassword:get'] = 'g_password';
			['connectpassword:set'] = "g_password  \"<ARG>\"\nsi_needPass 1";
			['rconpassword:get'] = 'net_serverRemoteConsolePassword';
			['rconpassword:set'] = 'net_serverRemoteConsolePassword  "<ARG>"';
		};
	};

Quake 4

	['Q4'] = {
		['RconProtocol'] = 'D3';

		['bRconQueue'] = true;
		['bSecondPortRcon'] = false;
		['bBanIP'] = true;
		['bBanID'] = false;
		['bBanTime'] = false;
		['bBanSave'] = false;
		['bUsername'] = false;
		['bExtraPort'] = false;
		['bUTF8'] = false;

		['PermBanTime'] = '';
		['BanTimeMult'] = 1;

		['Command'] = {
			['test'] = 'echo HLSW: Test';
			['say'] = 'say "<ARG>"';
			['listplayers'] = 'status';
			['listmaps'] = 'dir maps/mp .map';
			['changemap'] = "si_map <ARG>\nserverNextMap";
			['kick'] = 'gamekick "<PLAYERNAME>"';
			['connectpassword:get'] = 'g_password';
			['connectpassword:set'] = "g_password  \"<ARG>\"\nsi_usepass 1";
			['rconpassword:get'] = 'net_serverRemoteConsolePassword';
			['rconpassword:set'] = 'net_serverRemoteConsolePassword  "<ARG>"';
		};
	};

Prey

	['PREY'] = {
		['RconProtocol'] = 'D3';

		['bRconQueue'] = true;
		['bSecondPortRcon'] = false;
		['bBanIP'] = true;
		['bBanID'] = false;
		['bBanTime'] = false;
		['bBanSave'] = false;
		['bUsername'] = false;
		['bExtraPort'] = false;
		['bUTF8'] = false;

		['PermBanTime'] = '';
		['BanTimeMult'] = 1;

		['Command'] = {
			['test'] = 'echo HLSW: Test';
			['say'] = 'say "<ARG>"';
			['listplayers'] = 'status';
			['listmaps'] = 'dir maps/game .map';
			['changemap'] = "si_map <ARG>\nNextMap";
			['kick'] = 'gamekick "<PLAYERNAME>"';
			['connectpassword:get'] = 'g_password';
			['connectpassword:set'] = "g_password  \"<ARG>\"\nsi_usepass 1";
			['rconpassword:get'] = 'net_serverRemoteConsolePassword';
			['rconpassword:set'] = 'net_serverRemoteConsolePassword  "<ARG>"';
		};
	};

Games.cfg (Delayed)

Vietcong (better support)

• Game icon for Vietcong: http://seti.hlsw.org/hlsw/GameType_Vietcong.ico
• CBF file extractor for map detect http://aluigi.altervista.org/papers.htm#others-file

Example:

	['_Custom:Vietcong'] = {
		['Name'] = 'Vietcong';

		['InstallPathKeys'] = {
			[] = {
				['RegKey'] = 'HKEY_LOCAL_MACHINE\Software\Pterodon\Vietcong\InstallDir';
				['FileName'] = 'vietcong.exe';
			};
		};

		['DefaultFileName'] = 'vietcong.exe';

		['ConnectType'] = 'Parameter';
		['Parameter'] = {
//			['Default'] = '';
			['Password'] = vector('-password', '<PASSWORD>');
			['Name'] = vector('-pn', '<PLAYERNAME>');
			['Connect'] = vector('-ip', '<CONNECTIP>', '-hostport', '<CONNECTPORT>');
		};

//		['MapList'] = {
//			['Extension'] = '***';
//			['Type'] = 'CBF';
//		};

		['Query'] = {
			['LAN'] = {
				['DefaultQueryPort'] = 5425;
				['Protocol'] = 'GS';
			};

			['Protocol'] = {
				[0] = {
					['Protocol'] = 'GS';
					['Condition'] = 'None';
				};
			};
		};

		['Flags'] = set('Connect', 'GamersSearch');

		['Icon'] = 0000;
		['IconName'] = 'IDI_GAMETYPE_VIETCONG';
	};

For Addons.cfg

		[] = {
			['Type'] = 'AntiCheatTool';
			['Name'] = 'HB';
			['LongName'] = 'HradBa';
			['URL'] = 'http://wiki.hlsw.org/index.php/HradBa';
			['ParamRule']  = 'hbver';
		};

For ParamList.cfg

[] = {
         ['Name'] = 'Show FPS';
         ['Values'] = vector('-showfps', '1');
      };

For AddOns.cfg

		[] = {
			['Type'] = 'Plugin';
			['Name'] = 'AMX Super';
			['LongName'] = 'AMX Super All-in-One Commands';
			['URL'] = 'http://forums.alliedmods.net/showthread.php?t=19542&highlight=amx_super';
			['ParamRule'] = 'amx_super';
		};