View source for Plugin:Plasmo Voice

{{Infobox plugin
| image              = Plasmovoice.png
| name               = Plasmo Voice
| type               = Chat
| server             = {{SITENAME}}
| rootcommand        = groups
| custom             = No
| spigot=https://modrinth.com/plugin/plasmo-voice}}
{{Hatnote|{{Icon|notice}} {{SITENAME}} Staff are not able to moderate voice chat interactions in real-time. Apply caution when engaging with strangers online.}}

'''Plasmo Voice''' is a proximity chat plugin supported globally on {{SITENAME}} across all its servers. In order to use proximity chat, players must have the [https://modrinth.com/plugin/plasmo-voice/versions?l=fabric Plasmo Voice] mod installed on their Fabric client. With Plasmo Voice installed, players can communicate with others using voice chat, in-game, without relying on external third-party software.

Configuration is not required to use the mod on {{SITENAME}}. Other than the ability to create groups, commands are not required in order to use the mod. Instead, the mod contains a detailed in-game menu (Defaults to {{Key press|v}}) that allows you to configure audio, player, hud, and activation settings.

Players who have a working Plasmo Voice installation will appear with a speaker icon by their name in the {{Key press|Tab}} list.

== Features ==
* Talk to other nearby users who have the mod installed
* Configure the range at which others are able to hear you
* Create groups to chat with specific users regardless of distance
* Communicate with players across servers on the {{SITENAME}} Network
* Listen to custom music discs added to the server by other players
* See who is currently speaking by activating the HUD

== Installing the mod ==
{{Note|{{Icon|reference}} While the content of these guides are believed to be accurate, it does not contain specific instructions for every game version, and thus filenames within this guide will exclude version numbers. If there are other inaccuracies with the instructions listed below, please edit this page to correct them.}}
<tabber>
|-| Vanilla Launcher =
{{Rules
| title     = Installing the mod on Fabric [Windows]
| body      = <nowiki></nowiki>
#  Close all Minecraft instances and obtain all the necessary files for your game version: [https://fabricmc.net/use/installer/ Fabric launcher], [https://modrinth.com/plugin/plasmo-voice/versions?l=fabric Plasmo Voice],and [https://www.curseforge.com/minecraft/mc-mods/fabric-api/download Fabric API Mod].
# Once downloaded, double-click the <code>fabric-installer-x.x.x.exe</code> file, and install the launcher client. Make sure "Create profile" is selected. After the profile is installed, you may delete this file.
# Navigate to your <code>.minecraft</code> folder. On Windows, you can open this location by pressing {{Key press|Win}}+{{Key press|R}} and typing {{Copy|%appdata%}} into the dialog, and pressing OK.
# Double-click the mods folder. If it is not there, create it. Drag-and-drop <code>fabric-api-x.x.x+1.2x.jar</code> and <code>plasmovoice-fabric-1.2x-x.x.x.jar</code> into this folder.
# Open your Minecraft launcher. Ensure the <code>fabric-loader-1.2x profile</code> is selected, and launch the game. If it worked, you will see "Fabric" appear in the bottom left of the main menu screen.
# Once in-game, you can press the {{Key press|v}} key to open the voice chat settings panel. Select your microphone by clicking the bottom left button.

If your mod is successfully installed, you will see a speaker icon by your name in the {{Key press|Tab}} list when connected to Survival.
}}
{{Rules
| title     = Installing the mod on Fabric [macOS]
| body      = <nowiki></nowiki>
{{Note|{{Icon|alert}} Due to an[https://github.com/plasmoapp/plasmo-voice/issues/151 issue with macOS], Plasmo Voice is not able to access the system's microphone unless a third-party launcher is used.}}
#  Close all Minecraft instances and download [https://prismlauncher.org/download/mac/ Prism Launcher]. Prism Launcher is a third-party Minecraft launcher that is compatible with Plasmo Voice. Prism Launcher is not affiliated with {{SITENAME}}, but is considered safe to use.
# Install Prism Launcher and open it. Add your account by clicking the drop-down in the upper right. Prism Launcher will not ask for your account password directly, but will instead open an authentication page on the Microsoft website where you can link Prism Launcher with your Minecraft account.
# Once your account has been added, you can create a new profile (referred to as an "instance") by clicking the button in the upper left of the launcher. In the new window, assign a name to your profile, then select your desired game version ({{SITENAME}} recommends {{Home/settings|versionReal}}). Next, select the "Fabric" mod loader, and select the recommended version (indicated by a star icon). Click OK.
# Select your new profile, then click the "Edit" button in the sidebar. In the new window, select the "Mods" tab on the left, then click "Download mods" on the upper right.
# A new window will open. Search for "Plasmo Voice", and click "Select mod for download" in the lower right corner after selecting the mod. Click "Review and download". A new dialog will open, prompting you to download dependencies. Click OK.
# After the mods are downloaded, you may return to the main launcher window and launch your new profile.
# After launching, macOS should prompt you to give Minecraft microphone access. Accept this. Once in-game, you can press the {{Key press|v}} key to open the voice chat settings panel. Select your microphone by clicking the bottom left button.
}}
{{Rules
| title     = Installing the mod on Fabric [Linux]
| body      = <nowiki></nowiki>
#  Close all Minecraft instances and obtain all the necessary files for your game version: [https://fabricmc.net/use/installer/ Fabric launcher], [https://modrinth.com/plugin/plasmo-voice/versions?l=fabric Plasmo Voice],and [https://www.curseforge.com/minecraft/mc-mods/fabric-api/download Fabric API Mod]
# Once downloaded, double-click the <code>fabric-installer-x.x.x.exe</code> file, and install the launcher client. Make sure "Create profile" is selected.
# Navigate to your <code>.minecraft</code> folder. On Linux, you can access this location by opening your file manager and navigating to {{Copy|~/.minecraft}}. You may need to show hidden files by pressing {{Key press|Ctrl}}+{{Key press|H}}.
# Double-click the mods folder. If it is not there, create it. Drag-and-drop <code>fabric-api-x.x.x+1.2x.jar</code> and <code>plasmovoice-fabric-1.2x-x.x.x.jar</code> into this folder.
# Open your Minecraft launcher. Ensure the <code>fabric-loader-1.2x profile</code> is selected, and launch the game. If it worked, you will see "Fabric" appear in the bottom left of the main menu screen.
# Once in-game, you can press the {{Key press|v}} key to open the voice chat settings panel. Select your microphone by clicking the bottom left button.

If your mod is successfully installed, you will see a speaker icon by your name in the {{Key press|Tab}} list when connected to Survival.
}}

|-| Prism Launcher =
{{Rules
| title     = Downloading the mod on Prism Launcher [Universal]
| body      = <nowiki></nowiki>
#  Close all Minecraft instances and download [https://prismlauncher.org/download/ Prism Launcher] for your operating system. Prism Launcher is not affiliated with {{SITENAME}}, but is considered safe to use.
# Install Prism Launcher and open it. Add your account by clicking the drop-down in the upper right. Prism Launcher will not ask for your account password directly, but will instead open an authentication page on the Microsoft website where you can link Prism Launcher with your Minecraft account.
# Once your account has been added, you can create a new profile (referred to as an "instance") by clicking the button in the upper left of the launcher. In the new window, assign a name to your profile, then select your desired game version ({{SITENAME}} recommends {{Home/settings|versionReal}}). Next, select the "Fabric" mod loader, and select the recommended version (indicated by a star icon). Click OK.
# Select your new profile, then click the "Edit" button in the sidebar. In the new window, select the "Mods" tab on the left, then click "Download mods" on the upper right.
# A new window will open. Search for "Plasmo Voice", and click "Select mod for download" in the lower right corner after selecting the mod. Click "Review and download". A new dialog will open, prompting you to download dependencies. Click OK.
# After the mods are downloaded, you may return to the main launcher window and launch your new profile.
# Once in-game, you can press the {{Key press|v}} key to open the voice chat settings panel. Select your microphone by clicking the bottom left button.
}}
</tabber>

== Commands ==
{{Hatnote|{{Icon|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}}

{{Navplate
|title = Groups

|label1 = Description
|list1  = View, create, and join groups. Groups allow users to communicate over large distances, rather than using proximity mode, and even across servers. Using groups, players can control exactly who they wish to speak with.

|label2 = {{#inline-tooltip: Browse| /groups browse [page]}}
|list2  = Browse all active groups you can join. Only groups you can join will be shown in this list. To join a group, click the join button in chat.

|label3 = {{#inline-tooltip: Join| /groups join <group uuid> [password]}}
|list3  = Join a group you know the group UUID of. Using this command manually is not recommended; Instead, join a group through the {{CMD|groups browse}} command. This command can be auto-filled to input a password on a private group when used from the browse or invite subcommands.

|label4 = {{#inline-tooltip: Leave| /groups leave}}
|list4  = Leave the group you are currently in.

|label5 = {{#inline-tooltip: Info| /groups info}}
|list5  = Show info on your current group. The information returned is the same as what is shown when using {{CMD|groups browse}}, excluding all other group entries. 

|label6 = {{#inline-tooltip: Create| /groups create [flags...]}}
|list6  = Create a group. When creating a group, players can set a group name and password.
{{Component
|port     = {{Item|name_tag}}
|title    = '''Group Name'''
|subtitle = The name of the group shown in {{CMD|groups browse}}.
}}
{{Component
|port     = {{Item|oak_sign}}
|title    = '''Group Password''' (Optional)
|subtitle = A password players will be required to input when attempting to join this group.
}}

|label7 = {{#inline-tooltip: Invite| /groups invite <player>}}
|list7  = Invite a player to your current group.

|label8 = {{#inline-tooltip: Set| /groups set <flag> <value>}}
|list8  = Change or add a flag to your current group.

|label9 = {{#inline-tooltip: Unset| /groups unset <flag> <value>}}
|list9  = Set a flag within your group to the default state.

|label10 = {{#inline-tooltip: Transfer| /groups transfer <player>}}
|list10  = Transfer the ownership of your group to a different player.

|label11 = {{#inline-tooltip: Delete| /groups delete}}
|list11  = Delete the current group if you are the owner.
}}

== Examples ==
{{ExpandCard
| title     = Create a password-protected group
| body      = {{CMD|groups create name:My Friends password: secretPassword}}
}}

== Notes ==
* If others cannot hear you, ensure that the correct microphone is selected and unmuted, your microphone volume is turned up, and that you're using the correct voice activation mode.
** Setting your activation mode to Push-to-Talk is recommended while testing your activation settings.
* Players running on MacOS may need to launch the game through a third-party launcher, such as [https://prismlauncher.org/ Prism Launcher] (not affiliated with {{SITENAME}}), to start the game with microphone permissions enabled.
* Once all players leave a group (whether manually or by logging out) the group will be removed.
* There is not a way to kick players from groups. Ensure your group is password-protected if you wish to have private discussion.
* The activation key (Defaults to {{Key press|Right click}}) can be held while scrolling over a player to adjust their volumes live.
** The player's volume may overlap with the player's nametag while adjusting. This is not a bug and cannot be fixed by the server.
**  {{SITENAME}} recommends changing the activation key from its default as not to conflict with the server's player-ride feature.
* Wardens and Sculk Sensors can hear players using proximity chat. So far, this only applies to [[Survival]] and not [[Events]].
* Players can add custom sounds and music to the server through Music Discs. After purchasing the Custom Disc package from the [https://shop.prismparty.net/category/375615 {{SITENAME}} Webstore], players can submit an .mp3 file to [[Staff]] to add to the server.

== Gallery ==
<gallery mode="packed-hover" widths="130" heights="130">
File:ProximityDistance.png|The voice-range distance visualizer
File:PlasmoPlayers.png|The settings page, showing user volumes
PlasmoTabList.png|The player list, showing Plasmo Voice indicators
File:PlayerHUD.png|The HUD in the top left showing the player speaking
</gallery>

[[Category:Guides]]