ReltivlyObjectv / SpigotPluginQuickstart

A archetype for a simple spigot-plugin

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This is a maven-archetype to quickstart spigot plugin development

How to use

  • Open your terminal or command prompt
  • Switch to the directory you want the plugin to live in
  • Create the project using the archetype:
mvn archetype:generate \
-DarchetypeRepository=http://nexus.tkausl.net/content/groups/public/ \
-DarchetypeGroupId=net.tkausl.archetypes \
-DarchetypeArtifactId=spigot-plugin-simple \
-DarchetypeVersion=1.0-SNAPSHOT

Next steps

After creating the project, you should be able to compile the simple dummy-plugin, just switch in the plugins directory and type mvn install, your .jar will be in target/. To test the plugin, just copy the .jar-file in your servers plugins-folder and restart or reload the server. A dummy command is already implemented, just type / (its your artifactId) and you'll get a simple message, showing you the pluginname and the version.

Please read the Spigot Developer Informations for further informations on how to develop spigot-plugins, the JavaDoc lives here.

Contribute

I appreciate every help i can get. If you are missing something, feel free to open an Issue or Pull-Request.

FAQ

What is an Archetype?

An Archetype is mavens way to provide skeleton projects. Archetypes provide a directory-structure and a few default files, to quickstart a project without setting everything up again and again.

Your English is bad.

I hope its not too bad. English isn't my first language, feel free to message me or pull-request a change.

About

A archetype for a simple spigot-plugin


Languages

Language:Java 100.0%