Plugins

From Torch Wiki
Jump to navigation Jump to search

Plugins are software components that add features to your server, much like a mod.

Unlike mods, however, plugins do not have a whitelist and only run on the server, not on the client.

This allows plugins to do many things mods cannot do, but also allows them to compromise your system, which is why all plugins uploaded to the torch website are reviewed before they get added. Make sure the source of any plugin not on the torch website can be trusted before installing them.

What Plugins Are There?

There are three major plugins developed by the torch team: Essentials, Concelament and Profiler. These plugins should always be installed if you want the best experience using torch.

Others


How to install a Plugin

All plugins must now be listed in torch.cfg. If you install via UI, this will happen autmatically. Simply adding the zip to the plugin directory is no longer enough, zips on disk that are not listed in the cfg will be ignored. You may also use the -plugins commandline switch to load plugins

"torch.server.exe -plugins cbfdd6ab-4cda-4544-a201-f73efa3d46c0 f9470106-fad3-468f-ad60-82371c4764d3 17f44521-b77a-4e85-810f-ee73311cf75d"

Torch cfg will look like this

 <Plugins>
   <guid>cbfdd6ab-4cda-4544-a201-f73efa3d46c0</guid>
   <guid>f9470106-fad3-468f-ad60-82371c4764d3</guid>
   <guid>17f44521-b77a-4e85-810f-ee73311cf75d</guid>
 </Plugins>

You can find a plugins GUID in the URL of their page on the torch website

Example for Essentials: https://torchapi.net/plugins/item/cbfdd6ab-4cda-4544-a201-f73efa3d46c0

Or in the plugins Manifest file

You can disable this new behavior with -localplugins or by adding <LocalPlugins>true</LocalPlugins> to the cfg. Keep in mind this is an option intended for plugin developers and should be avoided if possible.

This system is backward compatible: if you do not have plugins listed in the cfg, Torch will search your plugin directory as usual, and add the plugins it finds to cfg for you. The plugin browser in the main UI will also add to the cfg when you install new plugins.

Additionally, unzipped plugins are no longer really supported-- this is intended for development use only. Unzipped plugins will not be updated automatically, though they will still load normally.

With UI

Go to the "Plugins" tab

Click the "Browse Plugins" Button at the bottom left

Select a Plugin and click "Download" then relaunch torch

How to configure a Plugin

Currently all changes to plugin configurations should be made while the server is not running. For this purpose, you can start torch without starting the server by setting Autostart to false in the torch.cfg

With UI

Most Plugins will simply come with UI if necessary. You can find it in the torch UI "Plugins" Tab

Keep in mind that the Plugins Tab UI will not necessarily work correctly with UI skins, so using the default is usually recommended

Without UI

After adding the plugin and starting the server with it, it will generate a configuration file if it can be configured.

Usually this file is located in your Instance Folder. Simply open it in a text editor, save your changes and start the server again.

If you can not locate the config file you can usually locate it by searching the torch folder for theplugin#s name.

Alternatively, you can install a local torch instance on your own Computer, use the UI and upload the config files to your server.

Keep in mind that many hosting companies can change how to install or configurate plugins, although these file actions should usually still work. If however they do not, do contact support of your provider

Development

Please reference Plugins/ObsoleteMembers for information on deprecated methods and members.

If you want to start getting into plugin development and don't know how to start you can check out this Plugin Development Tutorials