Gradle Plugin Template

A gradle template to use as a base for Minecraft b1.7.3 plugin development, including utility classes for common plugin tasks and convenience.

---

Utility Classes

• AboutUtil:

  • Provides methods to display detailed information about a plugin—including its name, version, description, website, author(s), and contributor(s)—to a player or the server console.

• AccessUtil:

  • Provides methods to check permissions and enforce command usage restrictions based on the sender's type.

• ColorUtil:

  • Provides a method to scan text for color codes prefixed with an ampersand & and replace them with the appropriate Minecraft color code format using the section sign § symbol.

• ConfigUtil:

  • Provides methods for loading, saving, and managing configuration files. It automatically handles the creation of parent directories and copies default configuration files from the plugin's resources if they do not exist.

• DiscordUtil:

  • Provides methods for setting up a Discord webhook message with content, username, avatar, text-to-speech (TTS) options, and rich embed objects.

• LogUtil:

  • Provides methods for logging info, warning, and severe messages through the server's logger into the console, simplifying the process of logging by avoiding the need to directly access the logger. Additionally, it allows to manage log files within the plugin's data folder where custom log messages can be written.

• UpdateUtil:

  • Provides a method to query the GitHub API for the latest release version and compares it with the current plugin version. It logs messages to the console indicating whether an update is available or if the plugin is up to date.

---

Contributing Code & Reporting Issues

Consider helping this template become even more versatile and robust.

Visit the CONTRIBUTING guide for details on how to get started and where to focus your efforts.

For any issues with the template, or suggestions, please report them here.

---

How To Clone

1. Via VCS:

   • Open IntelliJ IDEA.
   • Open File > New > Project from Version Control.
   • If you're on the dashboard home screen of the IDE, click CLONE FROM VCS on the top-right button.
   • In the URL field, paste the repository link:

     https://github.com/AleksandarHaralanov/gradle-plugin-template
     

   • Rename your project to have your desired plugin name.
   • Click Clone to download the project.

2. Via Git:

   • Open your terminal and run the following command:

     git clone https://github.com/AleksandarHaralanov/gradle-plugin-template.git <project-name>

---

Usage

Setup Project

While the project may be compatible with other Integrated Development Environments (IDEs), it is highly recommended to use IntelliJ IDEA by JetBrains for optimal performance.

JDK 1.8 Required: This project is built upon JDK 1.8. Ensure that your development environment is set up with JDK 1.8.

1. Set Up the Gradle JVM:
   • Open File > Settings > Build, Execution, Deployment > Build Tools > Gradle.
   • In the Gradle JVM dropdown, select Download JDK.
   • Choose JDK Version 1.8, Vendor is Eclipse Temurin, and keep the default location.
   • Ensure the newly downloaded JDK is selected, then click Apply and OK.
2. Configure the Project SDK:
   • Open File > Project Structure.
   • Under Project Settings, set the SDK to 1.8 and Language Level to SDK default.
   • Click Apply and OK.

Important

• Update package names org.example.plugin accordingly.
• Update src/main/resources/plugin.yml with your plugin details.
• Update settings.gradle with your plugin name.
• If you plan on publishing this plugin, you should update the documents within .github accordingly.

Build Project

Once you finish developing your plugin, follow these steps to build your project using Gradle:

• Click on the Gradle tab located in the right-side menu bar.
• Expand the Tasks/custom section and double-click on the cleanBuild task to start your first clean build process.
• After the process completes, a new build directory will appear in your project. Navigate to build/libs where you'll find your plugin's .jar file.
• You can now drag and drop your plugin into the plugins directory of your Minecraft b1.7.3 server.

Note

After every change to your plugin, you should be running the cleanBuild task and then retrieve the updated .jar file from build/libs, ready to be used.

Tip

If you want to exclude your plugin's version, retrieved from plugin.yml, from the plugin .jar file name, edit the archiveFileName field in build.gradle to "${project.name}.jar".