Plugin: Difference between revisions
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>..." |
Linux Flatpak config dir path |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
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: | 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) | * Linux without Flatpak: <code>~/.config/skytemple</code> (<code>$XDG_CONFIG_HOME</code> is used) | ||
* Linux with Flatpak: <code>~/.var/app/org.skytemple.SkyTemple/config/skytemple</code> | |||
* MacOS: <code>~/Library/Preferences/skytemple</code> | * MacOS: <code>~/Library/Preferences/skytemple</code> | ||
* Windows: <code>C:\Users\<username>\AppData\Local\skytemple</code> | * Windows: <code>C:\Users\<username>\AppData\Local\skytemple</code> | ||
| Line 15: | Line 16: | ||
== 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}} | |||
Latest revision as of 16:50, 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 without Flatpak:
~/.config/skytemple($XDG_CONFIG_HOMEis used) - Linux with Flatpak:
~/.var/app/org.skytemple.SkyTemple/config/skytemple - 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.