Plugins allow you to extend the functionality of OpenSim with new analyses and model components. A plugin comes in the form of a dynamically loaded library (.dll on Windows platform, .dylib on MAC, .so on Linux). It is straightforward to use a plugin that you have written or has been shared with you. Some existing, user-contributed plugins are available on the Simtk OpenSim Utilities page. To load a plugin use the following steps:
Graphical User Interface
- Make sure the plugin has been built and tested on your platform. If you're unsure of your platform, go to Help>About OpenSim>Details. The plugin must have been created using the same version of OpenSim (e.g. 3.0.1) and build system (e.g. Visual Studio 2010). Plugin distributors should supply this information to users.
- Close OpenSim.
- Place the plugin under the plugins folder within your OpenSim installation folder (if you installed this in the default location on Windows, this will be C:\OpenSim <version number>\plugins).
- Launch OpenSim. You should then see the plugin as a menu option under the User Plugins menu.
- From the User Plugins menu, click the name of the plugin to load it into OpenSim. You will be given the option to always preload the plugin each time OpenSim is launched. It is advised that you not do this until the plugin has been tested.
- To remove the plugin from the menu or disable the loading of it by the GUI, remove the plugin file from the plugins folder.
Matlab
- Make sure the plugin has been built and tested on your platform. If you're unsure of your platform, go to Help>About OpenSim>Details. The plugin must have been created using the same version of OpenSim (e.g. 3.0.1) and build system (e.g. Visual Studio 2010). Plugin distributors should supply this information to users.
- Add the directory that contains the plugin to the "librarypath" in Matlab (e.g. the default OpenSim plugins folder). In the Matlab command window type 'edit librarypath.txt'. Then add the appropriate directory.
- Use loadlibrary() or Model.LoadOpenSimLibrary("<full-path-to-DLL-file,-without-.dll-at-the-end>") as documented on the Matlab side to use the plugin.
Command Line
The command line version of the tools (e.g. forward, cmc, …) take an argument of the form “-L libraryName”. Thus, to use a plugin from the command line:
- Make sure the plugin has been built and tested on your platform. If you're unsure of your platform, go to Help>About OpenSim>Details. The plugin must have been created using the same version of OpenSim (e.g. 3.0.1) and build system (e.g. Visual Studio 2010). Plugin distributors should supply this information to users.
- Place the plugin in the same directory where as the executable you are running OR add the plugins folder to your path. (http://support.microsoft.com/kb/310519)
- Add the argument “-L libraryName” to the command.
Developing Plugins
You can learn more about developing your own plugins from the following resources:
3