Category:Plugins

Introduction

This page aims to describe how to use OpenKore plugins. Plugins are little perl packages (.pl extension) that extend OpenKore's functionality. They do this by reacting to built-in events in kore called hooks.

Downloading

You can download most plugins from the official OpenKore plugin repository at SourceForge:

• http://openkore.svn.sf.net/viewvc/openkore/plugins (manually)
• https://openkore.svn.sourceforge.net/svnroot/openkore/plugins (svn checkout - preferred method)

Notes:

• It is advised to get the entire <pluginname>/trunk folder of the plugin.
• Unofficial sources are unsafe to get plugins from. (forums, third party, ...)
• Using the plugins from the OpenKore plugin repository helps developers fix and maintain them, given that you provide bugreports and feedback..

Installing

Rename the trunk folder that you downloaded to <pluginname> and place it in the plugins folder so that you end up with plugins/<pluginname>.

plugins/
	macro/
		<files from ^/plugins/macro/trunk>
	state/
		<files from ^/plugins/state/trunk>
	randomplugin/
		<files from ^/plugins/randomplugin/trunk>
	...

Notes:

• OpenKore only looks for plugins down to 2 levels of the specified plugins folder. (ex. /plugins/<pluginname>/<pluginname.pl>)
• Additional configuration may be required to get the plugins to work. (in: sys.txt, config.txt, ...)
• Which plugins folder to use can be configured. (this is unnecessary in most cases)
• If you svn checkouting plugins, you can update them with svn up too.

Configuring

How to configure a specific plugin to your needs can be found on the forum and in some cases in <pluginname>/trunk/doc or directly in the plugin file. The goal is to port this information to the wiki (ex. macro plugin, wx captcha).