diff --git a/README.md b/README.md index 135e997..d815151 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,31 @@ > > ~Alexander the Crate -CrateCrate is a Sponge plugin for adding loot crates to your server. The plugin -is still in development, but you can join our Discord to stay up to date on -progress, assist with beta testing, and provide feedback/suggestions. +CrateCrate is a Sponge plugin for adding loot crates to your server. Though +still in development, CrateCrate is actively being used on servers and supports +all of the core features necessary for crates (see [Features](#features)). -- [Discord Server](https://discord.gg/zWqnAa9KRn) +Additionally, you can join our Discord to ask questions, stay up to date on +progress, assist with testing, and provide feedback/suggestions: + +- [Discord Server](https://discord.gg/zWqnAa9KRn) (please use the `#cratecrate` channel) + +https://user-images.githubusercontent.com/35618116/172282801-6256f891-6e58-4fcb-8f9a-2f2bfade600c.mp4 + +## Features + + - Core Features: + - Command, item, and money prizes + - Rewards supporting multiple prizes and built-in message/broadcast + - Firework, particle, potion, and sound effects + - GUI openers and menus for viewing keys or opening crates + - Quality of Life: + - Reusable config system with reasonably-sane defaults + - Detailed documentation, including config examples and in-game commands + - Descriptive errors for config/command errors (for *when* they happen) + - Extensibility: + - Support for custom messages and translations + - API extensibility for custom prizes, effects, etc (such as for mods) ## Sponsor Me! diff --git a/build.gradle b/build.gradle index c125274..22bf576 100644 --- a/build.gradle +++ b/build.gradle @@ -5,11 +5,11 @@ plugins { } group = "dev.flashlabs.cratecrate" -version = "0.0.2" +version = "0.0.3" ext.spongeapiVersion = "7.4.0" -ext.flashlibsVersion = "0.1.2" -ext.stormVersion = "0.1.0" +ext.flashlibsVersion = "v0.1.2" +ext.stormVersion = "master-SNAPSHOT" repositories { mavenCentral() @@ -20,8 +20,8 @@ repositories { dependencies { implementation("org.spongepowered:spongeapi:${spongeapiVersion}") - implementation("com.github.Flash-Labs:FlashLibs:v${flashlibsVersion}") - implementation("com.github.WillBAnders:Storm:v${stormVersion}") + implementation("com.github.Flash-Labs:FlashLibs:${flashlibsVersion}") + implementation("com.github.WillBAnders:Storm:${stormVersion}") } //Sets plugin metadata through Gradle build instead of the @Plugin annotation. @@ -42,7 +42,7 @@ sponge { shadowJar { dependencies { - include dependency("com.github.WillBAnders:Storm:v${stormVersion}") + include dependency("com.github.WillBAnders:Storm:${stormVersion}") } relocate("dev.willbanders.storm", "${project.group}.storm") version = "v$version" diff --git a/src/main/resources/assets/cratecrate/cratecrate.conf b/src/main/resources/assets/cratecrate/cratecrate.conf index 4e619ca..5bd6807 100644 --- a/src/main/resources/assets/cratecrate/cratecrate.conf +++ b/src/main/resources/assets/cratecrate/cratecrate.conf @@ -1,7 +1,10 @@ -//CrateCrate v0.0.2 -//GitHub: https://github.com/flash-labs/CrateCrate +//CrateCrate v0.0.3 +//Ore: https://ore.spongepowered.org/FlashLabs/CrateCrate +//Source: https://github.com/flash-labs/CrateCrate //Discord: https://discord.gg/zWqnAa9KRn +//FlashLabs: https://flashlabs.dev convert = { + //Warning: Converting will overwrite the current config - make a backup! teslacrate = false }