94 lines
3.9 KiB
Markdown
94 lines
3.9 KiB
Markdown
<!-- Variables (this block will not be visible in the readme -->
|
|
[spigot]: https://www.spigotmc.org/resources/79599/
|
|
[spigotRatingImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=rating&query=%24.rating.average&suffix=%20%2F%205&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F79599
|
|
[spigotDownloadsImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=downloads%20%28spigotmc.org%29&query=%24.downloads&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F79599
|
|
[issues]: https://github.com/FrankHeijden/ServerUtils/issues
|
|
[wiki]: https://github.com/FrankHeijden/ServerUtils/wiki
|
|
[release]: https://github.com/FrankHeijden/ServerUtils/releases/latest
|
|
[releaseImg]: https://img.shields.io/github/release/FrankHeijden/ServerUtils.svg?label=github%20release
|
|
[license]: https://github.com/FrankHeijden/ServerUtils/blob/master/LICENSE
|
|
[licenseImg]: https://img.shields.io/github/license/FrankHeijden/ServerUtils.svg
|
|
[bugReports]: https://github.com/FrankHeijden/ServerUtils/issues?q=is%3Aissue+is%3Aopen+label%3Abug
|
|
[bugReportsImg]: https://img.shields.io/github/issues/FrankHeijden/ServerUtils/bug.svg?label=bug%20reports
|
|
[reportBug]: https://github.com/FrankHeijden/ServerUtils/issues/new?labels=bug&template=bug.md
|
|
[featureRequests]: https://github.com/FrankHeijden/ServerUtils/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement
|
|
[featureRequestsImg]: https://img.shields.io/github/issues/FrankHeijden/ServerUtils/enhancement.svg?label=feature%20requests&color=informational
|
|
[requestFeature]: https://github.com/FrankHeijden/ServerUtils/issues/new?labels=enhancement&template=feature.md
|
|
[gradleInstall]: https://gradle.org/install/
|
|
[bStatsImg]: https://bstats.org/signatures/bukkit/ServerUtils.svg
|
|
[bStats]: https://bstats.org/plugin/bukkit/ServerUtils/7790
|
|
<!-- End of variables block -->
|
|
|
|
# ServerUtils
|
|
ServerUtils allows you to manage your plugins in-game.
|
|
Featuring reloading, unloading and loading of plugins from your plugins folder at runtime.
|
|
ServerUtils also has handy methods to lookup commands and plugins,
|
|
and provides you with handy information about them.
|
|
|
|
For the full description of this plugin, please refer to the ServerUtils [SpigotMC][spigot] page.
|
|
|
|
[![releaseImg]][release]
|
|
[](https://github.com/FrankHeijden/ServerUtils/actions)
|
|
[![licenseImg]][license]
|
|
[![featureRequestsImg]][featureRequests]
|
|
[![bugReportsImg]][bugReports]
|
|
[![spigotRatingImg]][spigot]
|
|
[![spigotDownloadsImg]][spigot]
|
|
|
|
[](https://discord.gg/WJGvzue)
|
|
|
|
[![bStatsImg]][bStats]
|
|
|
|
## Compiling ServerUtils
|
|
There are two ways to compile ServerUtils:
|
|
### 1. Installing gradle (recommended)
|
|
1. Make sure you have [gradle][gradleInstall] installed.
|
|
2. Run the project with `gradle build` to compile it with dependencies.
|
|
### 2. Using the wrapper
|
|
**Windows**: `gradlew.bat build`
|
|
<br>
|
|
**Linux/macOS**: `./gradlew build`
|
|
|
|
## Developer API
|
|
### Repository / Dependency
|
|
If you wish to use snapshot versions of ServerUtils, you can use the following repo:
|
|
```
|
|
https://repo.fvdh.dev/snapshots
|
|
```
|
|
|
|
#### Gradle:
|
|
```kotlin
|
|
repositories {
|
|
compileOnly("net.frankheijden.serverutils:ServerUtils:VERSION")
|
|
}
|
|
|
|
dependencies {
|
|
maven("https://repo.fvdh.dev/releases")
|
|
}
|
|
```
|
|
|
|
#### Maven:
|
|
```xml
|
|
<project>
|
|
<repositories>
|
|
<!-- Insights repo -->
|
|
<repository>
|
|
<id>fvdh</id>
|
|
<url>https://repo.fvdh.dev/releases</url>
|
|
</repository>
|
|
</repositories>
|
|
|
|
<dependencies>
|
|
<!-- Insights dependency -->
|
|
<dependency>
|
|
<groupId>net.frankheijden.serverutils</groupId>
|
|
<artifactId>ServerUtils</artifactId>
|
|
<version>VERSION</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
</project>
|
|
```
|
|
|
|
## Commands and Permissions
|
|
Please refer to the [SpigotMC][spigot] page for an updated overview of the commands and permissions.
|