mirror of
https://github.com/BG-Software-LLC/WildLoaders.git
synced 2024-11-10 10:09:55 +01:00
72 lines
2.6 KiB
Markdown
72 lines
2.6 KiB
Markdown
<p align="center">
|
|
<img src="https://bg-software.com/imgs/wildloaders-logo.png" />
|
|
<h2 align="center">The best alternative for alts!</h2>
|
|
</p>
|
|
<br>
|
|
<p align="center">
|
|
<a href="https://bg-software.com/discord/"><img src="https://img.shields.io/discord/293212540723396608?color=7289DA&label=Discord&logo=discord&logoColor=7289DA&link=https://bg-software.com/discord/"></a>
|
|
<a href="https://bg-software.com/patreon/"><img src="https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white&link=https://bg-software.com/patreon/"></a><br>
|
|
<a href=""><img src="https://img.shields.io/maintenance/yes/2021"></a>
|
|
</p>
|
|
|
|
## Compiling
|
|
|
|
You can compile the project using gradlew.<br>
|
|
Run `gradlew build` in console to build the project.<br>
|
|
You can find already compiled jars on our [Jenkins](https://hub.bg-software.com/) hub!<br>
|
|
|
|
When compiling you will receive errors about missing dependencies.<br>
|
|
These dependencies are premium plugins that cannot be published on a public repository.<br>
|
|
You can do either of the followings in order to solve it:
|
|
- Add manually all the jar files of the premium plugins.
|
|
- Purchase access to our private repository.
|
|
- Disabling compiling of the modules of these dependencies in the `gradle.properties` file.
|
|
|
|
<br>
|
|
|
|
##### Private Jars:
|
|
- EpicSpawners by Songoda [[link]](https://songoda.com/marketplace/product/13)
|
|
|
|
|
|
## API
|
|
|
|
The plugin is packed with a rich API for interacting with chunk loaders and more. When hooking into the plugin, it's highly recommended to only use the API and not the compiled plugin, as the API methods are not only commented, but also will not get removed or changed unless they are marked as deprecated. This means that when using the API, you won't have to do any additional changes to your code between updates.
|
|
|
|
##### Maven
|
|
```
|
|
<repositories>
|
|
<repository>
|
|
<id>bg-repo</id>
|
|
<url>https://repo.bg-software.com/repository/api/</url>
|
|
</repository>
|
|
</repositories>
|
|
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>com.bgsoftware</groupId>
|
|
<artifactId>WildLoadersAPI</artifactId>
|
|
<version>latest</version>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
##### Gradle
|
|
```
|
|
repositories {
|
|
maven { url 'https://repo.bg-software.com/repository/api/' }
|
|
}
|
|
|
|
dependencies {
|
|
compileOnly 'com.bgsoftware:WildLoadersAPI:latest'
|
|
}
|
|
```
|
|
|
|
## Updates
|
|
|
|
This plugin is provided "as is", which means no updates or new features are guaranteed. We will do our best to keep
|
|
updating and pushing new updates, and you are more than welcome to contribute your time as well and make pull requests
|
|
for bug fixes.
|
|
|
|
## License
|
|
|
|
This plugin is licensed under GNU GPL v3.0
|