0x277F/bukkit-plugin-annotations

 

Plugin Annotations

Table of Contents

• About
• Contacts
• Issues
• Building
• Contributing

About

A set of annotations for automagically generating Bukkit plugin descriptors.

Contacts

• IRC #Akkarin on irc.spi.gt (alternatively #Akkarin on esper.net)
• GitHub

Using

When running maven you may simply add a new dependency along with our repository to your pom.xml:

<repository>
        <id>torchmind</id>
        <url>https://maven.torchmind.com/snapshot/</url>
</repository>

<dependencies>
        <dependency>
                <groupId>com.torchmind.minecraft</groupId>
                <artifactId>plugin-annotations</artifactId>
                <version>1.0-SNAPSHOT</version>
                <scope>compile</scope>
        </dependency>
</dependencies>

For a detailed example of the annotations refer to ExamplePlugin.java. Keep in mind that you will need to enable annotation processing in your compiler configuration to be able to use this library.

Issues

You encountered problems with the mod or have a suggestion? Create an issue!

1. Make sure your issue has not been fixed in a newer version (check the list of closed issues
2. Create a new issue from the issues page
3. Enter your issue's title (something that summarizes your issue) and create a detailed description containing:
   • What is the expected result?
   • What problem occurs?
   • How to reproduce the problem?
   • Crash Log (Please use a Pastebin service)
4. Click "Submit" and wait for further instructions

Building

1. Clone this repository via git clone https://github.com/LordAkkarin/bukkit-plugin-annotations.git or download a zip
2. Build the modification by running ./gradlew build (or ./gradlew.bat build on Windows)
3. The resulting jars can be found in build/libs

To prepare a development environment you will need to run these additional commands:

1. ./gradlew setupDecompWorkspace (or ./gradlew.bat setupDecompWorkspace on Windows)
2. ./gradlew idea (or ./gradlew.bat idea) for IntelliJ users and ./gradlew eclipse (or ./gradlew.bat eclipse on Windows) for Eclipse users

Contributing

Before you add any major changes to the library you may want to discuss them with us (see Contact) as we may choose to reject your changes for various reasons. All contributions are applied via Pull-Requests. Patches will not be accepted. Also be aware that all of your contributions are made available under the terms of the Apache License 2.0. Please read the Contribution Guidelines for more information.