Difference between revisions of "Plugins"

From Torch Wiki
Jump to: navigation, search
(How to install a Plugin)
(How to install a Plugin)
 
Line 18: Line 18:
  
  
You can disable this new behavior with -localplugins or by adding <LocalPlugins>true</LocalPlugins> to the cfg.
+
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.
 
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.

Latest revision as of 17:22, 10 September 2019

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.


How to install a Plugin

All plugins must now be listed in torch.cfg. 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 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


There are three major plugins developed by the torch team: Essentials, Concealment and Profiler.

Development

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