diff --git a/README.md b/README.md index ce7f66e..e0deb50 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,26 @@ -# ExamplePluginTemplate -An example plugin template for beginners! +# SlashWelcome +A simple way to welcome new players ----------------------------------------------------- -Trying to create your first plugin? Use this template to get started easily! +Make poeple feel welcomed with one command! -- Comments to guide you -- Made some example classes -- Added some useful utils +- Multiple welcome messages +- Randomization +- Delay (Humanization) ----------------------------------------------------- ## How to use -Download this template -\> Load it into your IDE or development environment. [Check out IntelliJ](https://www.jetbrains.com/idea/download/?fromIDE=#section=windows) -\> Get Creative! +Download the latest realease or build it in gradle -- To build your jar file simply go into the terminal and run `./gradlew build` +- To build your jar file simply go into the terminal and run `gradlew build` - Your finished jar should appear in `build/libs`! +Install the plugin by dropping it in your plugins +- if you have [PlugManX](https://www.spigotmc.org/resources/plugmanx.88135/) +- - Do `/plugman load SlashWelcome` +- - Then `/plugman reload SlashWelcome` +- Otherwise do `/reload confirm` or restart the server ----------------------------------------------------- -Have a nice day, happy coding!