Update README.md

This commit is contained in:
2026-03-25 19:37:23 +01:00
parent d4e17d4739
commit b035cc4671

View File

@@ -1,3 +1,31 @@
# lagoon-plugin-minecraft-java <p align="center">
<a href="https://lagoon.under-scape.com">
<img src="https://cdn.modrinth.com/data/cached_images/16b47fe16787be657d51d829febd191f06d3d619.png" alt="Lagoon logo" width="150">
</a>
</p>
Plugin to connect your Minecraft server to Lagoon. ## 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!