Voxelite Docs Open the app

Getting started

Work through this once per studio. Later pages explain the screens you will land on.

1. Get a login

The sign-in page will not register you. An owner creates your login under Settings, then Users: email, username, a password of at least 8 characters, and a role.

2. Sign in

Open app.voxelite.org. Enter your email or username and your password. Voxelite then asks for a 6-digit code from an authenticator app. You cannot skip that. The password step does not sign you in by itself.

After the authenticator is enrolled, Settings, then Security, can add a passkey. A passkey can replace the password on later sign-ins. You still need the authenticator enrolled first.

You arrive on the dashboard for the account. It is empty until a player joins a connected server.

3. Open a game

Games for the account are listed in the sidebar under the account-wide pages. Click the game. The tabs under it are the ones that game has, filtered by what your role can read: Maps, Packs, Tags, Minigames, Connectors, Servers.

4. Connect a Minecraft server

Do this in Voxelite before you start the server process. On the game, open Servers and click Create a server. Enter a title. Description is optional. Turn on the server features you want, then create it.

The dialog prints a config. Copy it before you close the dialog. The server key in that config is not shown again.

base-url: https://api.voxelite.org
organization-id: "<account id>"
server-key: "<shown once>"

organization-id is filled in with your account id. Paste the block into the plugin config:

Start the server. Back in Voxelite, open that server. Joins and chat show up on the live view once players connect. Details are on the Servers page.

5. Claim your Minecraft account

You need this to send chat from a live server. Open Settings, then Profile. Add a Minecraft account. It stays unverified until you claim it. Click Claim in-game. Voxelite shows a /voxelite claim command. Run that command on the server as the player. On Spigot and Paper the player needs the voxelite.claim permission.

6. Add the rest of the team

Settings, then Users, then Add person. You type their email, username, password, and role. Then adjust Roles if Member should do more than view. See People and access.