diff --git a/README.md b/README.md index 8c39d7e..e5571a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ -# lagoon-plugin-minecraft-java +

+ + Lagoon logo + +

-Plugin to connect your Minecraft server to Lagoon. \ No newline at end of file +## Presentation + +Lagoon plugin is a plugin to use Lagoon Proximity Chat system **and only this system**. + +### How it works? + +- Download the plugin +- Install it on your server (paper/purpur/spigot) +- Restart your server +- Config the plugin `/plugins/LagoonPlugin/config.yml` +- Restart your server +- When players join they obtain a code +- Enter the code on Lagoon +- Enjoy! + +### Config + +```yaml +room-code="your-lagoon-room-code" +``` + +On Lagoon, in your room you will obtain a room code — put it into `room-code`. + +> ⚠️ **Warning** +> This code only works on Lagoon, don't share it! \ No newline at end of file