Skip to content

Create Plugin

Lars edited this page Sep 7, 2020 · 1 revision

Table of contents

Requirements

The plugins are written in Java, therefore some Java knowledge and a development setup (JDK & IDE) is required.

  • Java (at least JDK 8)
  • Maven (optional)
  • IDE (Eclipse, IntelliJ, Netbeans...)

Dependencies

Without Maven

To get all the features and access to the Swing UI, download the RemoteLight jar (min v0.2.4-rc1) from GitHub. The jar contains all required dependencies.

Project

Create a new Java project in the IDE of you choice and add the RemoteLight jar to the build path.
To do so create a folder (e.g. libs) in the project root and copy the jar file into it.
Include external library...

Eclipse: Right click on project folder > Configure Build Path > Libraries Tab > Add External Jar > select the jar file

IntelliJ: File > Project Structure > Libraries > click on add (plus symbol) > Java and select the jar file

Maven

Create a new Maven project and edit the pom.xml:

Add JitPack repository:

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add RemoteLight dependency:

	<dependency>
	    <groupId>com.github.Drumber</groupId>
	    <artifactId>RemoteLight</artifactId>
        <!-- set to new version if available -->
	    <version>v0.2.4-rc2</version>
	</dependency>

...or if you only need the plugin core interface:

	<dependency>
	    <groupId>com.github.Drumber.RemoteLight</groupId>
	    <artifactId>remotelight-plugincore</artifactId>
        <!-- set to new version if available -->
	    <version>v0.2.4-rc2</version>
	</dependency>

Download dependencies: mvn install

Example pom.xml

example pom.xml file

➥ Next: Properties File