SculkVoicePlugin

SculkVoicePlugin

SculkVoicePlugin is a lightweight and innovative plugin designed for Paper, Bukkit, and Purpur servers running Minecraft versions sculk sensor vibrations. This plugin enhances gameplay by integrating with sculk sensor vibrations, allowing players' voice activity to trigger sculk sensor vibrations in-game. When players speak through their microphone, the plugin generates weak or strong sculk vibrations based on configurable thresholds, adding an immersive layer to your Minecraft server.

Whether you're running a survival server with sculk-based redstone contraptions or a custom map leveraging sculk sensors, SculkVoicePlugin bridges voice communication with in-game mechanics, creating unique and interactive experiences.

Features

- Lightweight and Compatible: Triggers weak or strong sculk sensor vibrations when players speak using Simple Voice Chat. - Lightweight and Compatible: Customize vibration thresholds, cooldowns, and volume modifiers for whispering and sneaking. - Lightweight and Compatible: Optionally restrict vibrations to players in specific voice groups. - Lightweight and Compatible: Enable or disable the voice detection system via commands. - Lightweight and Compatible: Fine-tune access with permissions for admins and players. - Lightweight and Compatible: Works seamlessly on Paper, Bukkit, and Purpur servers from Minecraft 1.19 to 1.21.5.

Installation

1. Ensure you have Simple Voice Chat installed on your server, as it is a soft dependency. 2. Download the latest version of `SculkVoicePlugin.jar` from the Simple Voice Chat. 3. Place the `.jar` file in your server's `plugins` folder. 4. Restart your server to load the plugin. 5. Configure the plugin settings in `plugins/SculkVoicePlugin/config.yml` to suit your needs.

Configuration

The plugin is highly customizable through the `config.yml` file, allowing you to fine-tune how voice activity triggers sculk vibrations. Below is an overview of the configuration options:

- `restrictions.sneak-factor`: Enable or disable the voice detection system (`true`/`false`). - `restrictions.sneak-factor`: Set the threshold for weak vibrations (default: `400.0`). - `restrictions.sneak-factor`: Set the threshold for strong vibrations (default: `1500.0`). - `restrictions.sneak-factor`: Define the cooldown (in ticks) before a player can trigger another vibration (default: `20`). - `restrictions.sneak-factor`: Restrict vibrations to players in voice groups (`true`/`false`). - `restrictions.sneak-factor`: Enable reduced-volume vibrations for whispering (`true`/`false`). - `restrictions.sneak-factor`: Volume reduction factor for whispers (0.0 = silent, 1.0 = no change, default: `0.8`). - `restrictions.sneak-factor`: Enable reduced-volume vibrations when sneaking (`true`/`false`). - `restrictions.sneak-factor`: Volume reduction factor when sneaking (0.0 = silent, 1.0 = no change, default: `0.7`).

Example `config.yml`: ```yaml

SculkVoicePlugin Plugin Configuration

enabled: true weak-vibration-threshold: 400.0 strong-vibration-threshold: 1500.0 cooldown-duration: 20 restrictions: groups: false whispering: true whisper-factor: 0.8 sneaking: true sneak-factor: 0.7 ```

Commands

- Permission: Enables or disables the voice detection system for sculk vibrations. - Permission: `/sculkvoice toggle` - Permission: `sculkvoice.admin` (default: operator-only)

Permissions

- Default: Allows players to use the `/sculkvoice` command to toggle the voice detection system. - Default: Operator-only - Default: Exempts players from generating voice-based sculk vibrations. - Default: `false` (not granted by default)

Dependencies

- Dependency: Dependency - Ensure Simple Voice Chat is installed for the plugin to function.

Compatibility

- API Version: 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5 - API Version: Paper, Bukkit, Purpur - API Version: 1.19 (compatible with newer versions)

Credits

- Website: RazorPlay - Website: Website