LiveKit

What is LiveKit?
LiveKit is more than just a live map that shows what your players are up to. Administrate your server right out of your pocket, manage your world weather, player bans, whitelisting, open inventories, teleport players and much more! Get started with LiveKit with ease and discover all the features we have to offer. This plugin is in active development with new features coming your way regularly!


Getting started
Server setup
- Download the latest version of the LiveKit plugin -> Move it to your plugins folder
- Reload or restart your server
- Take note of the console output from LiveKit. It will tell you the IP and Port you will need to connect through the app!

App setup
- Download LiveKit App from on of the stores mentioned at the top of this page
- In the App tap on + Connect and enter the IP and Port from the step above
- Follow the instructions in the App, either connect anonymously, or identify which player you are by using the /livekit claim command in-game and entering the code in the app

NOTE: Port forwarding LiveKit port (default 4123) is !recommended!. Port forwarding allows the App to directly connect to your server. If you don’t setup port forwarding, the connection will be proxied through our proxy service, which will impact connection speed and stability

If you are having issues getting started, join our Discord and ask for help!

Setting up your world for rendering
The map is limited by a predefined boundary, so you control how big your rendered map will be. By default the bounds are rectangular and 1024x1024 blocks (or 64x64 chunks, 2x2 regions)

Set your bounds
/livekit <world> bounds <radius> [-r|-c]
For example, /livekit main_world bounds 4096 -c would set your rendered map border to a circular (-c) shape, with a radius of 4096 blocks

Start a full render
/livekit <world> render full
This will start a full render of the world, inside of your bounds defined with the command above. Don’t overdo your bounds, doing a full render takes a while.


Permissions
If you are using a Vault supported Permissions Plugin (for example LuckPerms) set useVault option to true in the LiveKit config.yml. Make sure to have Vault in your plugins folder.

Permissions for Players