Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 3.6 KB

README.md

File metadata and controls

116 lines (84 loc) · 3.6 KB
Raw

Contributors Forks Stargazers Issues Apache 2.0 License

Spigot Utils

A small library of commonly used functions in Spigot plugins
View Javadocs »

Report Bugs · Request Features

Table of Contents
  1. Usage
  2. Compiling
  3. Contributing
  4. License

Usage

Implementing in your project

Make sure to replace VERSION in the below examples with the version below:

Maven Central

Maven

<dependency>
    <groupId>net.insprill</groupId>
    <artifactId>spigot-utils</artifactId>
    <version>VERSION</version>
</dependency>

Gradle (Groovy)

dependencies {
    implementation 'net.insprill:spigot-utils:VERSION'
}

Gradle (Kotlin)

dependencies {
    implementation("net.insprill:spigot-utils:VERSION")
}

Compiling

To compile spigot-utils, you need JDK 17 or higher and an internet connection.
Clone this repo, then run ./gradlew build from your terminal.
You can find the compiled jar in the build/libs directory.
If you wish to install it to your local Maven repository, run ./gradlew publishToMavenLocal after compiling.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Make your changes.
  4. Stage your changes (git add .)
  5. Commit your Changes (git commit -m 'Add some AmazingFeature')
  6. Push to the Branch (git push origin feature/AmazingFeature)
  7. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.