Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/despical/commons

Common utilities needed for Java and Minecraft
https://github.com/despical/commons

commons library minecraft

Last synced: 2 months ago
JSON representation

Common utilities needed for Java and Minecraft

Awesome Lists containing this project

README

        

Commons

[![](https://github.com/Despical/Commons/actions/workflows/build.yml/badge.svg)](https://github.com/Despical/Commons/actions/workflows/build.yml)
[![](https://img.shields.io/github/v/release/Despical/Commons)](https://github.com/Despical/Commons/releases/latest)
[![](https://jitpack.io/v/Despical/Commons.svg)](https://jitpack.io/#Despical/Commons)
[![](https://img.shields.io/badge/License-GPLv3-blue.svg)](../LICENSE)
[![](https://img.shields.io/badge/javadoc-latest-lime.svg)](https://javadoc.jitpack.io/com/github/Despical/Commons/latest/javadoc/index.html)

Commons is a open-source library that provides utilities needed for Java and Minecraft.

## Documentation
- [Wiki](https://github.com/Despical/Commons/wiki)
- [JavaDocs](https://javadoc.jitpack.io/com/github/Despical/Commons/latest/javadoc/index.html)

## Using Commons
The project isn't in the Central Repository yet, so specifying a repository is needed.

Maven dependency

```xml

jitpack.io
https://jitpack.io

```
```xml

com.github.Despical
Commons
1.8.81

```

Gradle dependency

```
repositories {
maven { url 'https://jitpack.io' }
}
```
```
dependencies {
implementation 'com.github.Despical:Commons:1.8.81'
}
```

## License
This code is under [GPL-3.0 License](http://www.gnu.org/licenses/gpl-3.0.html).

See the [LICENSE](https://github.com/Despical/Commons/blob/master/LICENSE) file for required notices and attributions.

## Donations
- [Patreon](https://www.patreon.com/despical)
- [Buy me a Coffee](https://www.buymeacoffee.com/despical)

## Contributing

I accept Pull Requests via GitHub. There are some guidelines which will make applying PRs easier for me:
+ No spaces! Please use tabs for indentation.
+ Respect the code style.
+ Create minimal diffs. If you feel the source code should be reformatted create a separate PR for this change.

You can learn more about contributing via GitHub in [contribution guidelines](https://github.com/Despical/Commons/blob/master/CONTRIBUTING.md).

## Building from source
To build this project from source code, run the following from Git Bash:
```
git clone https://www.github.com/Despical/Commons.git && cd Commons
mvn clean package -Dmaven.javadoc.skip=true -DskipTests
```

> [!IMPORTANT]
> Don't forget to install Maven before building.