README.md

Alchema

This Minecraft (Bukkit) plugin aims to introduce in-world cauldron crafting, witchcraft and sorcery for CraftBukkit and Spigot servers. Licensed under GPLv3, releases are made on GitHub to comply with this license. You are welcome to fork this project and create a pull request or request features/report bugs through the issue tracker. Please see the Contribution Guidelines below.

For information about the plugin and how to use it, please see the plugin's resource page on SpigotMC.

Depending on Alchema API

Alchema is kindly hosted by md_5 on his repository and can be depended on with either Maven or Gradle.

Maven

<project>
  ...
  <repositories>
    <id>md_5-repository</id>
    <url>https://repo.md-5.net/content/repositories/snapshots/</url>
  </repositories>
  ...
  <dependencies>
    <dependency>
      <groupId>wtf.choco</groupId>
      <artifactId>Alchema</artifactId>
      <version>1.2.0-SNAPSHOT</version> <!-- Or whatever version -->
      <scope>provided</scope>
    </dependency>
  </dependencies>
  ...
</project>

Gradle

repositories {
  jcenter()
  maven { url "https://repo.md-5.net/content/repositories/snapshots/" }
}

dependencies {
  implementation 'wtf.choco:Alchema:1.2.0-SNAPSHOT' # Or whatever version
}

Contribution Guidelines

If you plan on contributing to Alchema, thank you! Contributions are much appreciated. Please follow the following guidelines if you plan on contributing either as a developer or a user of this plugin.

Suggesting a Feature

You do not have to be a developer to contribute to this project. Requesting features helps me out just as much! In order to suggest a feature, please visit the issues tab and select the most appropriate issue template. The templates should guide you on how to make a ticket but please be as thorough as possible as to not require any additional inquiries for information not provided in the original ticket.

If you would like to suggest a recipe to be added to the default set of recipes, please create a ticket using the "New cauldron recipe" template. Include the JSON file and a reason as to why you believe this recipe should be added. Additionally, please include the name that you would like to use as it will be included in the recipe file itself for author attribution.

Creating a Pull Request

When creating a pull request, it is expected that your changes have been tested and will compile successfully. Alchema makes use of a few different compile-time checks including Checkstyle and JUnit tests to ensure that code quality meets basic standards.

PLEASE be sure that your changes compile! This makes the review process easier and ensures that a follow-up commit need not be created to patch any compile errors. This means that tests should be enabled and passed (run mvn test in the command line or through your IDE) and no Checkstyle violations should be present.