Giter VIP home page Giter VIP logo

spigot-archetype's Introduction

Spigot Archetype

Maven archetype for creating Spigot plugins.

Usage

To use the archetype locally, clone it and install it to your local repository using the following commands in an empty directory. After that, you may add it to your local catalog.

git clone https://github.com/SkeletonEye/spigot-archetype.git .
mvn install

After doing that once, you can generate a new project using:

mvn archetype:generate -DarchetypeArtifactId=spigot-archetype -DarchetypeGroupId=de.skeletoneye.maven -DarchetypeVersion=0.1.0-SNAPSHOT

You can test the archetype by running test.sh. A sample project will be set up in test/testplugin.

Contents

Files

File Description
pom.xml Your fully configured Project Object Model. The version number you set here will be inserted into your plugin.yml every time you make a build.
src/main/java/[...].java Contains your plugin's main class.
src/main/javadoc/overview.html Contains general information about your project which will be merged into the overview page of the generated site. Read more:
Maven Javadoc Plugin: "Using Javadoc Resources"
Oracle's Javadoc Documentation: "Overview Comment Files"
src/main/javadoc/.../package-info.java Contains information about this package to be included in the docs. Read more:
Oracle's Javadoc Documentation: "Package Comment Files"
src/main/resources/plugin.yml Your plugin description file. Read more: BukkitWiki: "Plugin YAML"

Maven Build Plugins

Maven Dependency Plugin: Moves the final artifact to test-server/plugins every time you make a build so that you set up a local test server over there. If you add maven-assembly-plugin to create -jar-with-dependencies.jar artifacts, add <classifier>jar-with-dependencies</classifier> to <artifactItem> in this plugin's configuration.

Maven Javadoc Plugin: Generates Javadoc.

Lombok Maven Plugin: Includes methods and constructors generated by Lombok into the docs. If you remove Lombok from your maven dependencies or the maven-javadoc-plugin, you should remove this plugin as well. If you keep maven-javadoc-plugin but wish to remove Lombok, make sure to remove <sourcepath> from the Javadoc plugin's configuration.

spigot-archetype's People

Contributors

syntaxcacao avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.