How to whitelist players on a Hytale server
Whitelist players on a Hytale server from the Console. Run /help whitelist, allow yourself and your admins first, then enable it. On Update 6 and later the whitelist grants the hytale.server.join permission. Covers lockouts and whitelist.json.
To whitelist players on a Hytale server, open the server Console, run
/help whitelist to see the whitelist subcommands for your build, allow
yourself and everyone who should still get in, and only then enable it.
Hypixel doesn't publish a fixed signature for these commands, so that help
text is your exact syntax.
On Update 6 and later, the whitelist is the hytale.server.join permission,
and the whitelist commands grant and revoke it for each player.
Allow yourself and your admins before you enable the whitelist. Otherwise the game client can refuse every join, including yours. Official Update 6 notes don't say administrators or other roles stay allowed automatically.
Whitelist players
Open Console on a running server
On berrybyte, start the server from Overview if it's stopped, then open the Console tab. A running server means help reflects your build.
Read the whitelist commands
Run this and read the subcommands your build exposes:
/help whitelist
If help lists a status or list subcommand, run it to see whether the whitelist is already required and who's allowed.
Allow yourself and your admins first
Use the add or grant form help prints. These commands grant and revoke
hytale.server.join. They aren't a second list beside permissions.
Enable the whitelist
Use the enable form help prints. The new state is saved to disk before the command returns, and the server keeps the previous state if the save fails.
Join once yourself
Connect with Join your Hytale server before you tell anyone the server is locked down. If you can't get in, disable the whitelist from Console with the matching subcommand, then fix the list.
Console keeps working even when the game client can't join. Keep it open until you've confirmed you can connect.
Chapter 1 (October 12) may change whitelist commands or permissions.
Recheck /help whitelist after you
update your server.
Whitelist files
whitelist.json, permissions.json, bans.json, and config.json live
together in the server folder (open them in Files on berrybyte). Per the
Hytale Server Manual,
the server reads them on startup and writes them when in-game or Console
actions run, so manual edits while it's running are likely overwritten. Use
commands while the server runs, or stop it before editing and start it again.
On Update 6 and later, whitelist.json isn't the live list. Don't rename
whitelist.json.migrated back and expect it to work.
Whitelist, password, and Discovery
| Control | What it does | Who gets in |
|---|---|---|
| Whitelist | Per-player allow list | Only players you allowed |
| Password | Shared secret, when you set one | Anyone who knows it and passes the other checks |
| Server Discovery | Official public in-game list | Anyone who can find a listed server that's otherwise open |
A Discovery listing doesn't disable the whitelist, and a password doesn't add anyone to it. See password setup and Server Discovery.
Older builds (Update 5)
Which build am I on? On berrybyte, check Settings → Game Settings →
Patchline (release or pre-release). release includes Update 6, and
Auto Update (on by default) moves the server to the latest build on that
channel at restart. If /help whitelist describes a provider list with
whitelist.json as the live file, you're on Update 5.
An Update 5 server uses a whitelist provider and whitelist.json, which the
manual lists next to config.json, permissions.json, and bans.json.
Auto-update backups can include that file. Use only the subcommands
/help whitelist prints, and don't assume Minecraft-style on and off.
Allow yourself and every admin first, then enable. Update 5 notes don't
document a guaranteed operator bypass. Prefer commands over hand-editing,
and if you open whitelist.json, stop the server first and don't invent
keys.
What Update 6 changed: it removed HytaleWhitelistProvider, moved the
whitelist to hytale.server.join, migrated whitelist.json to
whitelist.json.migrated, and made enable and disable persist immediately.
Membership and state writes share one lock.
Related guides
Frequently asked questions
How do I whitelist players on a Hytale server?
Open Console on the running server and run /help whitelist to see the subcommands for your build. Allow yourself and every admin first, then enable the whitelist. On berrybyte, keep the Console tab open so you can undo it if nobody can connect.
Where is the Hytale whitelist file?
On Update 5 servers the live list is whitelist.json in the server folder. On Update 6 and later, access is the hytale.server.join permission and an old whitelist.json is renamed whitelist.json.migrated. Use commands while the server runs, because manual edits are likely overwritten.
Can I lock myself out of a Hytale server with the whitelist?
Yes. If you enable the whitelist before allowing yourself and your admins, the game client can refuse every join. Official Update 6 notes don't promise operators stay exempt. Console keeps working, so disable the whitelist from there.
What changed in the Hytale whitelist in Update 6?
Update 6 removes HytaleWhitelistProvider, so whitelist commands now grant and revoke the hytale.server.join permission. An existing whitelist.json is renamed whitelist.json.migrated. Enable and disable are saved before the command returns and roll back if the save fails.
Is the Hytale whitelist the same as a password or Server Discovery?
No. A whitelist is a per-player allow list, a password is a shared secret, and Server Discovery is the official public in-game list. Listing a server doesn't open it, and a password doesn't replace a whitelist.