Getting Started
Plugins are at the heart of Vime because everything outside of the core is built as one. Basically plugins are Svelte components that implement the plugin interface and add some functionality/feature to the player. Plugins can be interacted with through the props, methods and events they expose.
#
Installing Plugins#
QuickYou can get started quickly by simply using the Boot
plugin which will install all Vime plugins. It
also provides the option of turning off plugins you don't need, see the Boot
plugin page
for more information.
#
ModularIf you want more control then you can pick and use only what you need.
- JavaScript
- Svelte
#
DynamicIf you want to dynamically add/remove plugins you can use the PluginsManager
.
- JavaScript
- Svelte
info
You can still do this with the plugins
prop, but the manager has a much better interface for this.
#
Interacting with PluginsAll Vime plugins are attached to the player and can be accessed via their plugin ID
. All Vime plugins
follow the naming convention of v{PluginName}
.
- Keyboard =
vKeyboard
- ActionDisplay =
vActionDisplay
- Controls =
vControls
#
Simple Example- JavaScript
- Svelte
#
Advanced Example- JavaScript
- Svelte