Formerly known as "cs-corelib2", dough is a very powerful library aiming to help the everyday Spigot/Plugin developer. It is packed to the brim with useful features and APIs to use and play around with.

Dough may be more commonly known as the backbone of Slimefun.

⚠️ Note that this project can be considered officially abandoned, because Slimefun has been discontinued. This is only an unofficial repo with some fixes and updates.

1. Getting Started
   • Adding dough via gradle
   • Adding dough via Maven
2. Features & Documentation
   • TODO
3. Discord server

Dough is hosted on maven-central (OSS Sonatype) for easy access. Furthermore, it consists of multiple different submodules.

If you want to utilise the entirety of dough, use the artifact dough-api.
Otherwise replace dough-api in the following examples with whatever module you want to import. Note that some modules have dependencies on other modules, all modules require dough-common as an example.

Dough can easily be included in gradle using mavenCentral.
Simply replace [DOUGH VERSION] with the most up to date version of dough:

repositories {
	mavenCentral()
}

dependencies {
	implementation 'io.github.baked-libs:dough-api:[DOUGH VERSION]'
}

To shadow dough and relocate it:

plugins {
  id "com.github.johnrengelman.shadow" version "7.0.0"
}

shadowJar {
   relocate "io.github.bakedlibs.dough", "[YOUR PACKAGE].dough"
}

Dough can easily be included be added using maven-central.
Simply replace [DOUGH VERSION] with the most up to date version of dough:

<dependencies>
  <dependency>
    <groupId>io.github.baked-libs</groupId>
    <artifactId>dough-api</artifactId>
    <version>[DOUGH VERSION]</version>
    <scope>compile</scope>
  </dependency>
</dependencies>

To shadow dough and relocate it:

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>3.2.4</version>

      <configuration>
        <relocations>
          <relocation>
            <pattern>io.github.bakedlibs.dough</pattern>
            <shadedPattern>[YOUR PACKAGE].dough</shadedPattern>
          </relocation>
        </relocations>
      </configuration>

      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>shade</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

TODO: Finish this section

You can also find us on discord by the way! If you need any help with dough or have a question regarding this project, feel free to join and connect with other members of the community. Note that this server is not as active at times, so response times may vary.