From a09bebb6fac76391b118945fd77fdaea531f8a0d Mon Sep 17 00:00:00 2001 From: trivernis Date: Sat, 8 Feb 2020 14:28:54 +0100 Subject: [PATCH] Update README --- README.md | 28 ++++++++++++++++++++++++---- build.gradle | 1 - 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9470446..2c1f8f0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,19 @@ and resumes when the server is empty again. The generation also auto-resumes aft restart. The plugin tracks the ticks per second and pauses the generation when the tps is lower than 2 (configurable). -## Commands +## Built with + +- [Gradle](https://gradle.org/) - Dependency Management and Build Tool +- [Sqlite JDBC](https://bitbucket.org/xerial/sqlite-jdbc/) - Database Driver for JDBC +- [bStats](https://bstats.org/) - Statistical Insights + +## Installing + +Just download the jar from the latest release and place it into the servers plugins folder. + +## Usage and Configuration + +### Commands All features can be accessed with the command `/chunkmaster` or the aliases `/chm`, `chunkm`, `cmaster`. @@ -18,7 +30,7 @@ All features can be accessed with the command `/chunkmaster` or the aliases `/ch - `/chunkmaster reload` Reloads the configuration file. - `/chunkmaster tpchunk ` Teleports you to the specified chunk coordinates. -## Config +### Config ```yaml @@ -83,8 +95,16 @@ generation: pause-on-join: true ``` -## Spigot and Paper +### Spigot and Paper The plugin works on spigot and paper servers but is significantly faster on paper servers (because it profits from asynchronous chunk loading an the better implementation of the -isChunkGenerated method). \ No newline at end of file +isChunkGenerated method). + +## License + +This project is licensed under the GPLv3.0 License - see the [License.md](https://github.com/Trivernis/spigot-chunkmaster/blob/master/LICENSE) for details. + +## bStats + +[![Plugin statistics](https://bstats.org/signatures/bukkit/chunkmaster.svg)](https://bstats.org/plugin/bukkit/Chunkmaster/5639) \ No newline at end of file diff --git a/build.gradle b/build.gradle index e9148c8..a24dac6 100644 --- a/build.gradle +++ b/build.gradle @@ -48,7 +48,6 @@ dependencies { compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8" implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" testCompile group: 'junit', name: 'junit', version: '4.12' - //compileOnly "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT" compileOnly "com.destroystokyo.paper:paper-api:1.14.4-R0.1-SNAPSHOT" compile group: 'org.xerial', name: 'sqlite-jdbc', version: '3.28.0' compile "io.papermc:paperlib:1.0.2"