Skip to content

Player UI

VoiceHub provides two in-game UI pages: the Channel Browser for players and the Admin Panel for administrators. Both are built with Hytale’s InteractiveCustomUIPage system.

Open with /ksvoice open (aliases: menu, ui). Requires the ks.voice.user.open permission (granted by default).

The Channel Browser uses a split layout:

  • Left panel — Channel list or Create tab (switchable via tabs)
  • Right panel — Your current channel details

The default tab shows all channels on the server in a paginated list (8 channels per page).

Each channel row displays:

  • Name — the channel display name
  • Type — Group, Whisper, Moderated, Global, or Proximity
  • Members — current count and limit (e.g. 3/20 or 5/inf)
  • Flags[PW] for password-protected, [MOD] for moderated, [INV] for invite-only

Click a channel to expand its detail panel inline:

FieldDescription
NameChannel display name
DescriptionChannel description text
TypeFull type description (e.g. “Group (worldwide)”, “Proximity (64 blocks)“)
FlagsPassword, Moderated, Invite-Only indicators
Password fieldShown only if the channel is password-protected and you are not already a member
Join buttonJoin the selected channel (hidden if you are already in it)

:::tip Admin Bypass Players with the kyuubisoft.voicehub.admin permission bypass password and invite-only restrictions when joining through the UI. :::

Join error messages:

  • “Wrong password!” — incorrect password entered
  • “Channel full!” — member limit reached
  • “Invite only!” — channel requires an invitation
  • “Voice-banned! X min remaining” — player is blacklisted
  • “No permission!” — channel has a join permission the player lacks

Switch to the Create tab to make a new channel.

FieldDescription
NameChannel name (required, 2-32 characters, alphanumeric, spaces, hyphens, underscores)
DescriptionOptional description text
TypeDropdown: Group, Whisper, or Moderated
PasswordOptional password to protect the channel

Below the type dropdown, a description of the selected type is shown:

TypeDescription
GroupAll members hear each other worldwide
WhisperPrivate 1-on-1 (max 2)
ModeratedOnly talk-power holders can speak

Click Create to create the channel and automatically join it. You become the channel owner.

The right panel shows your current channel information.

When not in a channel:

  • Shows “Not in channel”

When in a channel:

SectionContent
HeaderChannel name, description, full type label, owner name
MembersCurrent count and limit
Moderation”Moderated” label if applicable
LeaveButton to leave the channel (disabled for default channels)

Member List:

Displays up to 8 members with:

  • Player name (with a cross-mark indicator if the member is in a different world)
  • Role badge: O = Owner, M = Moderator, music note = has talk power (in moderated channels)
  • Kick button (visible to Owner/Moderator, not shown for yourself)
  • Talk Power toggle button (visible to Owner/Moderator in moderated channels)
  • Avatar — player’s HyVatar head render (first 6 slots, requires KyuubiSoft Core)

If there are more than 8 members, a “+N more” label appears.

Cross-World Warning:

When channel members are in different Hytale worlds, a warning banner appears:

Players in other worlds cannot hear you.

This includes a count of how many members are affected.

When you are a regular member in a moderated channel and do not have talk power, a Request Talk Power section appears:

  • Reason text field — optional reason for your request
  • Request button — sends a notification to the channel’s owner and moderators
  • Mods see: [VoiceHub] PlayerName requests talk power: reason

When you are the channel owner, an Edit section appears below the member list:

FieldDescription
NameRename the channel
DescriptionUpdate description
Max MembersChange the member limit
PasswordSet or change password
TypeDropdown: Group, Whisper, Moderated, Proximity
RangeCustom hearing range in blocks (0 = unlimited/global)
SaveApply changes
DeletePermanently delete the channel (all members moved to default)

Open with /ksvoice admin panel. Requires the kyuubisoft.voicehub.admin permission.

See the Admin Panel page for full documentation.

At the top of the Channel Browser, a status label shows your current channel:

  • In: ChannelName — when you are in a channel
  • Not in channel — when you are not in any channel