Plugin: Difference between revisions

From SkyTemple
Created page with "SkyTemple can be extended using plugins. == Installing Plugins == To install Plugins, open SkyTemple and select "Open config directory..." from the hamburger menu. This will open the configuration directory. You can also navigate to the following folder manually: * Linux: <code>~/.config/skytemple</code> (<code>$XDG_CONFIG_HOME</code> is used) * MacOS: <code>~/Library/Preferences/skytemple</code> * Windows: <code>C:\Users\<username>\AppData\Local\skytemple</code>..."
 
SkyTemple Nav template
Line 15: Line 15:
== Developing Plugins ==
== Developing Plugins ==
If you want to develop your own plugin, you can find the instructions in the <code>[https://github.com/SkyTemple/skytemple/blob/master/docs/plugin_dev.rst docs/plugin_dev.rst]</code> file in the SkyTemple repository.
If you want to develop your own plugin, you can find the instructions in the <code>[https://github.com/SkyTemple/skytemple/blob/master/docs/plugin_dev.rst docs/plugin_dev.rst]</code> file in the SkyTemple repository.
{{NavSkyTemple}}

Revision as of 11:55, 17 September 2023

SkyTemple can be extended using plugins.

Installing Plugins

To install Plugins, open SkyTemple and select "Open config directory..." from the hamburger menu. This will open the configuration directory. You can also navigate to the following folder manually:

  • Linux: ~/.config/skytemple ($XDG_CONFIG_HOME is used)
  • MacOS: ~/Library/Preferences/skytemple
  • Windows: C:\Users\<username>\AppData\Local\skytemple

Within that directory you will find a directory "plugins". Place the downloaded plugin "whl" file within that directory and restart SkyTemple.

List of Plugins

A list of plugins can be found in Category:Plugin.

Developing Plugins

If you want to develop your own plugin, you can find the instructions in the docs/plugin_dev.rst file in the SkyTemple repository.