Properties File

Table of contents

• Introduction
• Properties
  • Required properties
  • Optional properties
• Example Properties File

Introduction

Every RemoteLight plugin must have a plugin.properties in the root directory of the jar file. The properties file contains information about the plugin, such as the main class, plugin name, author, version etc. The plugin cannot be loaded without this file.

Properties

Required properties

Property name	Description
main	path to the plugin's Main class
name	unique plugin name
author	plugin author
version	plugin version (preferred format x.x.x)

Optional properties

Property name	Description
displayname	alternative plugin name
url	plugin website/repository url
scope	application scope where the plugin works (all, swing, web)
minVersion	minimum required RemoteLight version
maxVersion	maximum RemoteLight version
dependencies	list of plugins the plugin needs to work
softdependencies	list of plugins the plugin optionally requires

Dependencies property

With this parameter you can define other plugins which must also be located in the plugins folder. The specified plugins will be loaded before the plugin, so that the functions of the dependent plugins can be accessed without problems.
If any of the dependencies is not installed, the plugin will not be loaded and an error message will appear in the console.

Softdependencies property

Same as the dependency property, except that the plugin is loaded even if the defined soft-dependencies are not installed.

Example Properties File

Example plugin.properties file located in MyPlugin/src/ on non-maven projects or in MyPlugin/src/main/resources on maven projects.

main=com.maxo.myplugin.PluginMain
name=MyPlugin
displayname=My awesome Plugin
author=Maxo
version=0.1
scope=swing,web
minVersion=v0.2.4-rc2
maxVersion=v0.99.1

Non-Maven file structure

Maven file structure

➥ Next: Plugin Main Class