plugins.info module

Provides plugin information storing.

class plugins.info.PluginInfo(name, verbose_name=None, author=None, description=None, version=None, url=None, permissions=None, public_convar=True, display_in_listing=None, **kwargs)

Bases: dict

Store information for a plugin.

__init__(name, verbose_name=None, author=None, description=None, version=None, url=None, permissions=None, public_convar=True, display_in_listing=None, **kwargs)

Initialize the instance.

Parameters:

• name (str) – Name of the plugin on the file system.

• verbose_name (str) – A verbose name for the plugin (e.g. GunGame).

• author (str) – Name of the author.

• description (str) – A short description of what the plugin does.

• version (str) – Current version of the plugin.

• url (str) – A link to a thread in the ‘Plugin Releases’ forum section or the plugin’s SPPM link.

• permissions (list) – A list of permissions defined or used by the plugin. The list should contain tuples that define the permission and a short description of the permission.

• public_convar – If set to True, a public convar will be generated based on the plugin name, verbose name and version. Set it to False if you don’t want a public convar or set it to a dictionary containing the parameters to create a cvars.public.PublicConvar instance.

• display_in_listing (list) – A list that contains custom attributes that should appear in the plugin listing (e.g. sp plugin list).

• kwargs – Any additional attributes you want to set. If you want those attributes to appear in the plugin listing, update display_in_listing.

get_verbose_name()

Return the verbose name of the plugin.

If no verbose name has been set, the plugin name will be titled.

Return type:

str

get_version()

Return the plugin’s version.

Return type:

str

set_verbose_name(value)

Set the verbose name of the plugin.

set_version(value)

Set the plugin’s version.

property verbose_name

Return the verbose name of the plugin.

If no verbose name has been set, the plugin name will be titled.

Return type:

str

property version

Return the plugin’s version.

Return type:

str