Plugin-template

Spigot plugin setup for Maven in Eclipse. This repository is a template for Maven projects in Eclipse to develop Java plugins. Maven will update the dependencies and project settings based on the project descriptor. This will help automate the development

Table of contents

• Usage
  • prerequisites
  • steps
• references
• License

Usage

Prerequisites

Name	Description	Version
Eclipse	The essential tools for any Java developer.	Eclipse IDE for Java Developers
Java	Java lets you develop and deploy Java applications on desktops and servers.	JDK and JRE 8 or newer

Steps

• Clone this git repository into your Eclipse workspace using EGit, GitHub or Git.

• Right-click the repository in Git Repositories and click Import projects.

  • Set the Import source to the repository where the .git folder is located.
  • Select Plugin-template/Template as the folder.
  • Finish the setup

• Right-click the project in Package Explorer and select Refactor

  • Rename the Maven Artifact to match your namespace.
  • Rename the Java Project to match your plugin.

• Open Template.java in src/main/java

  • Rename the gloryrock.template.main Java package to match your namespace.
  • Rename or replace the main class Template.java with something that match your entry point.

• Open pom.xml in the project root

  • Rename the groupId to match your own namespace.
  • Rename artifactId to your own plugin name.
  • Change the source and target version of Java to the ones you've installed.
  • Change the spigot-api version to the most recent one found here.

• Open plugin.yml in src/main/resources

  • Change the name to your plugin name.
  • Change the main to your own main class in the package that matches your namespace.
  • Change the author to your username.
  • Change the description to match your plugin.

References

Using the Spigot-API

User-contributed code examples for simple plugins

Creating your first bukkit plugin

The Maven project descriptor

License

This project is licensed under the MIT License. Licenses of tools and dependencies are not included and may vary.