Update README.md with configuration and player connection instructions
This commit is contained in:
19
README.md
19
README.md
@@ -1,3 +1,20 @@
|
|||||||
# lagoon-bedrock-addon
|
# lagoon-bedrock-addon
|
||||||
|
|
||||||
A Bedrock add-on to enable proximity chat in Lagoon on a Minecraft Bedrock server.
|
A Bedrock add-on to enable proximity chat in Lagoon on a Minecraft Bedrock server.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
### Setting up the Room Code
|
||||||
|
|
||||||
|
Depending on whether you're developing or using the add-on as-is:
|
||||||
|
|
||||||
|
- **For developers**: Edit the room code in `src/properties.ts`
|
||||||
|
- **For users**: Edit the room code in `scripts/properties.js`
|
||||||
|
|
||||||
|
### Connecting Players
|
||||||
|
|
||||||
|
1. Players will receive a code when joining the game
|
||||||
|
2. Go to [lagoon.under-scape.com](https://lagoon.under-scape.com)
|
||||||
|
3. Join the room using the room code configured in the add-on
|
||||||
|
4. Enter your player code in the settings
|
||||||
|
5. You're now connected and can enjoy proximity chat!
|
||||||
Reference in New Issue
Block a user