AddOns.cfg

From HLSW Wiki

1 Syntax
2 New entries
3 Existing entries

Syntax

This document is a work progress of discussions with Strimo and a bit of experimenting. The rules that the config file must abide can be found here Config_Format.

[edit]

Level 0

All addons must be held within an 'AddOns' block, this can be done by doing...

['AddOns'] = {
	<-- Level 1 -->
};

[edit]

Level 1

Level 1 is a block statement that contains all addons related to that key. The key is the abbreviation that is known by HLSW. A list of known games be found here -- Insert Link--

['AddOns'] = {
	['HL'] = {
		<-- Level 2 -->
	};
	['HL2'] = {
		<-- Level 2 -->
	};
};

[edit]

Level 2

Level 2 contains the individual block for each plugin and is used to segregate each plugin. The key for this element can be left empty. However, if the user would like to use an integer then that is allowed.

['AddOns'] = {
	['HL'] = {
		[] = {
			<-- Level 3 -->
		};
	};
};

[edit]

Level 3

Level 3 is the final level and contains just standard key = value pairs with all the required information. If a key has no value, then that key does not need to be added.

'Type' - describes where to show the AddOn in HLSW (Plugin, Anti-Cheat or Ranking)
'Name' - is the shortened name of a plugin, which will be displayed, if the serverdetails-window isn't width enough to show all Plugins Longnames.
'Longname' - The full name of the Plugin
'VerRule' - This is the cvar, which identifies the plugin from a gameservers cvar list.
'URL' - This is the link, which opens up in your browser, when you click on a plugins name in the server details window. It is recommended to set this link to a page in this Wiki, as Websites and domains are changing, but this Wiki and its articles stay. This way the HLSW coders don't have to change the URL in HLSW on every Release, if there was a move or something.

['AddOns'] = {
	['HL'] = {
		[] = {
			['Type'] = 'AddOn';
			['Name'] = 'AM';
			['LongName'] = 'Admin-Mod';
			['VerRule'] = 'admin_mod_version';
			['URL'] = 'http://wiki.hlsw.org/index.php/Admin-Mod';
		};
		[] = {
			['Type'] = 'AddOn';
			['Name'] = 'CM';
			['LongName'] = 'ClanMod';
			['VerRule'] = 'clanmod_version';
		};
	};
};

[edit]

Examples

['AddOns'] = {
	['HL'] = {
		[] = {
			['Type'] = 'AddOn';
			['Name'] = 'AM';
			['LongName'] = 'Admin-Mod';
			['VerRule'] = 'admin_mod_version';
			['URL'] = 'http://wiki.hlsw.org/index.php/Admin-Mod';
		};
		[] = {
			['Type'] = 'AddOn';
			['Name'] = 'CM';
			['LongName'] = 'ClanMod';
		};
		[5] = {
			['Type'] = 'AddOn';
			['Name'] = 'LM';
			['LongName'] = 'LogMod';
			['VerRule'] = 'logmod_version';
			['URL'] = 'http://wiki.hlsw.org/index.php/LogMod';
		};
	};
};

[edit]