Plugin: Difference between revisions

From TotalcmdWiki
Jump to navigation Jump to search
m (Introduction, text)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Introduction ==
A '''plugin''' is a [http://en.wikipedia.org/wiki/Library_(computer_science)#Dynamic_linking dynamically linked library] that can be added to [[Total Commander]] in order to extend or improve Total Commander's functionality. Thus a plugin can be considered an [[addon]]. Most plugins are third party software, though [[Christian Ghisler]] did create several plugins himself.


Plugins are made to extend the functionality of Total Commander individually.  
== Plugin types ==
The size of the main program stays small and fast, adapted by the user and his personal needs.
 
Total Commander currently supports four plugin types:
 
* [[Packer plugin]]s (.wcx files) - Packer plugins are used to pack/unpack/modify specific file types, usually archive formats.
* [[File system plugin]]s (.wfx files) - File system plugins are used via the Network Neighborhood. They usually access some remote system or a certain part of your PC which cannot be accessed via drive letters.  
* [[Lister plugin]]s (.wlx files) - Lister plugins display special file types in the built-in lister as well as in the quick view panel (Ctrl+Q).
* [[Content plugin]]s (.wdx files) - Content plugins have several purposes: searching for specific file properties and contents, displaying of these properties in file lists, and using them in the multi-rename tool to add them to the file name.


Plugins are special  [http://en.wikipedia.org/wiki/Library_(computer_science) libraries] to implement additional functions. These DLLs are not run by the user but by Total Commander. The benefit of this technique is having a common interface for each plugin type.
== Where to find plugins? ==


== Plugin types ==
Several lists of plugins can be found in this wiki:
* [[List of packer plugins]]
* [[List of file system plugins]]
* [[List of lister plugins]]
* [[List of content plugins]]
* [[List of 64-bit plugins and addons]]
* [[List of unreleased plugins]] - List of unreleased plugins which are currently neither listed on totalcmd.net nor released officially on ghisler.com.


Total Commander currently supports four plugin types:
Links to other plugin resources are listed at:
* [[TotalcmdWiki:Community_portal#Plugin_and_addon_centers|Community_portal#Plugin_and_addon_centers]].


* [[Packer plugins]] (usually have .WCX file extension)
== Plugin installation ==
* [[File system plugins]] (.WFX extension)
* [[Lister plugins]] (.WLX extension)
* [[Content plugins]] (.WDX extension)


There are several ways to install plugins:


== Where to find plugins? ==
* [[#Installation using Total Commander's integrated plugin installer|Installation using Total Commander's integrated plugin installer]].
* [[#Installation using the plugin's own installer|Installation using the plugin's own installer]].
* [[#Manual installation of plugins|Manual installation of plugins]].


The most convenient way to find them is by using the following sites:
=== Installation using Total Commander's integrated plugin installer ===


* [http://totalcmd.net/ totalcmd.net] you should visit first if you want to stay up-to-date with plugins and [[Tools]].
Often a plugin can be installed by simply opening the plugin installation archive from within Total Commander. Simply '''double clicking''' the plugin installation '''archive''' will launch Total Commander's built-in plugin installer. This only works if the following conditions are met:
* [http://en.totalcmd.pl/ totalcmd.pl] is the Polish site containing a large number of plugins, [[Tools]], documentation and so on. At first it was in Polish only, but now it has English version too.
* You are using Total Commander version 6.5 or later.
* <strike>[http://www.clubtotal.tk/ Club Total]</strike> unfortunately is not available now. However, there is still hope that it will rise again some day.
* The plugin installation archive supports installation by the integrated installer (i.e. it contains a valid '''pluginst.inf''' file).
* [http://www.ghisler.com/addons.htm Official addon site] is the best choice if you prefer final "tested by author" versions. This is the place to go if you don't like any experiments.
* The option "Configuration" -> "Options..." -> "Packer" -> "''Treat archives like directories''" is '''enabled'''.
* [[Unreleased plug-ins]]: A wiki page full of unreleased plug-ins which are currently neither listed on totalcmd.net nor released officially on ghisler.com.
* The parameter ''AutoInstallPlugins=0'' is '''not''' set in the [Configuration] section of the wincmd.ini file.
* The plugin archive has not been opened in order to view its contents (for example with Ctrl-PgDn). In this case open and close another archive in the same file panel - this will re-initiate auto-installation for the wanted plugin archive, so that double clicking it once again should start the auto-installation.


=== Installation using the plugin's own installer ===


== Plugin installation ==
Some plugins come with there own installer. Launch this installer in order to install the plugin.


Since Total Commander version 6.5 an integrated installer for plugins is available.
=== Manual installation of plugins ===
Whenever you want to install a plugin now, all to do is: Open the downloaded archive with a doubleclick.
The setup will start automatically. An installation "by hand" is still possible.
The programs in the next chapter can be very usefull to manage all your plugins.


Some (older) plugins need to be installed manually. The basics steps to install such plugins are:
* Unpack the plugin archive to a folder.
* Add the plugin to Total Commander using Total Commander's configurations options.


== Plugin management ==
== Plugin management ==
Line 52: Line 67:




== Plugin development guides ==
== Information for developers ==
 
Each plugin is a DLL which exports a set of functions specific to the plugin type and described in the following pages:
* [[Packer plugins developer guide]]
* [[File system plugins developer guide]]
* [[Lister plugins developer guide]]
* [[Content plugins developer guide]]
 


== Plugin programming interfaces ==
See [[Developer's corner]].


Plugin programming interfaces make it possible to develop a plugin in your prefered programming language (apart from [http://en.wikipedia.org/wiki/C++ C++] and [http://en.wikipedia.org/wiki/Delphi_programming_language Delphi]).
* [http://www.totalcmd.net/plugring/dotnet.html .Net Framework Wrapper] for WFX
* [http://www.totalcmd.net/plugring/perlfs.html Perl FS] for WFX
* [http://www.totalcmd.net/plugring/tc_java.html Java Plugin Interface] for WCX, WDX, WFX and WLX
* [http://www.totalcmd.net/plugring/ScriptWFX.html VBScript Plugin Interface] for WFX
* [http://www.totalcmd.net/plugring/script_wdx.html VBScript / JavaScript Plugin Interface] for WDX
* [http://www.totalcmd.net/plugring/wlx_vbscript.html VBScript / JavaScript Plugin Interface] for WLX


----
----


Back to [[Main_Page]]
Back to [[Main Page]]
[[Category:Plugins| ]]
[[Category:Plugins| ]]


[[de:Plugins]]
[[de:Plugins]]

Latest revision as of 20:04, 21 October 2021

A plugin is a dynamically linked library that can be added to Total Commander in order to extend or improve Total Commander's functionality. Thus a plugin can be considered an addon. Most plugins are third party software, though Christian Ghisler did create several plugins himself.

Plugin types

Total Commander currently supports four plugin types:

  • Packer plugins (.wcx files) - Packer plugins are used to pack/unpack/modify specific file types, usually archive formats.
  • File system plugins (.wfx files) - File system plugins are used via the Network Neighborhood. They usually access some remote system or a certain part of your PC which cannot be accessed via drive letters.
  • Lister plugins (.wlx files) - Lister plugins display special file types in the built-in lister as well as in the quick view panel (Ctrl+Q).
  • Content plugins (.wdx files) - Content plugins have several purposes: searching for specific file properties and contents, displaying of these properties in file lists, and using them in the multi-rename tool to add them to the file name.

Where to find plugins?

Several lists of plugins can be found in this wiki:

Links to other plugin resources are listed at:

Plugin installation

There are several ways to install plugins:

Installation using Total Commander's integrated plugin installer

Often a plugin can be installed by simply opening the plugin installation archive from within Total Commander. Simply double clicking the plugin installation archive will launch Total Commander's built-in plugin installer. This only works if the following conditions are met:

  • You are using Total Commander version 6.5 or later.
  • The plugin installation archive supports installation by the integrated installer (i.e. it contains a valid pluginst.inf file).
  • The option "Configuration" -> "Options..." -> "Packer" -> "Treat archives like directories" is enabled.
  • The parameter AutoInstallPlugins=0 is not set in the [Configuration] section of the wincmd.ini file.
  • The plugin archive has not been opened in order to view its contents (for example with Ctrl-PgDn). In this case open and close another archive in the same file panel - this will re-initiate auto-installation for the wanted plugin archive, so that double clicking it once again should start the auto-installation.

Installation using the plugin's own installer

Some plugins come with there own installer. Launch this installer in order to install the plugin.

Manual installation of plugins

Some (older) plugins need to be installed manually. The basics steps to install such plugins are:

  • Unpack the plugin archive to a folder.
  • Add the plugin to Total Commander using Total Commander's configurations options.

Plugin management

These tools were created to make the plugin installation and management easier:

You might need a tool for managing your plugins when:

  • You want to install plugins by double-clicking plugin files
  • You want to install zipped plugins pack (archive that contains several plugins)
  • You want to install a bunch of plugins located in a folder and all its subfolders
  • You want to install two different plugins for the same extension
  • You want to temporary disable some plugins
  • You want to change the loading order of Packer plugins


Information for developers

See Developer's corner.


Back to Main Page

Retrieved from "http://www.ghisler.ch/wiki/index.php?title=Plugin&oldid=9204"