Giter Club home page Giter Club logo

dough's Introduction

๐Ÿฅฏ Dough


Build Status javadocs Maven Central Code Coverage Maintainability


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.

Note that this project is still under heavy development, we don't advise using this just yet as some things are still drafts and subject to change. Documentation is still lacking and we try to improve this until we go live. We plan to go live in September of 2021. Check back then! ;)

๐Ÿ“„ Table of contents

  1. Getting Started
  2. Features & Documentation
    • TODO
  3. Discord server

๐Ÿ” Getting Started

Dough is hosted on maven-central (OSS Sonatype) for easy access. Furthermore it consists of multiple different submodules. You will learn about the different modules in a later section (โœจ Features and Documentation).

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.

Adding dough via gradle

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

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"
}

Adding dough via Maven

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

<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>

โœจ Features and Documentation

TODO: Finish this section

๐ŸŽง Discord server

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.

Discord Invite

dough's People

Contributors

thebusybiscuit avatar renovate-bot avatar walshydev avatar sfiguz7 avatar renovate[bot] avatar j3fftw1 avatar starwishsama avatar md5sha256 avatar angeschossen avatar wiiiiam278 avatar epicplayera10 avatar ajan-12 avatar kii-chan-reloaded avatar ybw0014 avatar sefiraat avatar barpec12 avatar qwertyuioplkjhgfd avatar poslovitch avatar linoxgh avatar mooy1 avatar jikoo avatar jwjun233233 avatar l4borg avatar rymiel avatar ncbpfluffybear avatar char3210 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.