Getting Started

Starting From Scratch

If you are starting your project from scratch, you can use one of the provided project templates:

With Existing Mods/Plugins

If you already have a project, that you want to integrate Simple Voice Chat into, follow the steps below.

Fabric

To add the API dependency to your Fabric mod, add the following maven repository to your project.

build.gradle

groovy

repositories {
    ...
    maven { url = 'https://maven.maxhenkel.de/repository/public' }
}

In the dependencies section add the following maven dependency. Make sure voicechat_api_version is set to the voice chat API version you want to target. Available API versions can be found here.

build.gradle

groovy

dependencies {
    ...
    implementation "de.maxhenkel.voicechat:voicechat-api:${voicechat_api_version}"
}

To avoid crashes due to outdated voice chat API versions, make sure to add voicechat_api to the depends section in the fabric.mod.json. This prevents your mod from loading if versions of the voice chat are installed, that are older than the API version you are targeting.

fabric.mod.json

json

{
  "schemaVersion": 1,
  ...
  "depends": {
    ...
    // Note that the mod ID "voicechat_api" was introduced with API version 2.6.0 - For older versions you need to depend on the mod ID "voicechat"
    "voicechat_api": ">=${voicechat_api_version}"
  }
}

To register the voice chat plugin for a Fabric mod, you need to create a class that implements de.maxhenkel.voicechat.api.VoicechatPlugin.

TestPlugin.java

java

package com.example.yourmod;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}

Additionally, you need to add a voicechat entrypoint in your fabric.mod.json, that refers to the class you just created.

fabric.mod.json

json

{
  "schemaVersion": 1,
  ...
  "entrypoints": {
    "main": [
      ...
    ],
    "voicechat": [
      "com.example.yourmod.TestPlugin"
    ]
  },
  ...
}

To have Simple Voice Chat installed in your development environment, use the Modrinth Maven Repository. Alternatively use Cursemaven.

build.gradle

groovy

repositories {
    ...
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}
dependencies {
    ...
    modRuntimeOnly "maven.modrinth:simple-voice-chat:fabric-${voicechat_version}"
    // On Fabric, you also need to add the API stub dependency, which provides the mod ID "voicechat_api" for you to depend on.
    // If you install the mod normally, this would already be included, but in development nested mods are not included.
    // Note that this is available starting with API version 2.6.0
    modRuntimeOnly "de.maxhenkel.voicechat:voicechat-api:${voicechat_api_version}:fabric-stub"
}

Neoforge/Forge

To add the API dependency to your Forge mod, add the following maven repository to your project.

build.gradle

groovy

repositories {
    ...
    maven { url = 'https://maven.maxhenkel.de/repository/public' }
}

In the dependencies section add the following maven dependency. Make sure voicechat_api_version is set to the voice chat API version you want to target. Available API versions can be found here.

build.gradle

groovy

dependencies {
    ...
    implementation "de.maxhenkel.voicechat:voicechat-api:${voicechat_api_version}"
}

To avoid crashes due to outdated voice chat versions, make sure to add voicechat to the dependencies section in the mods.toml. This prevents your mod from loading if versions of the voice chat are installed, that are older than the API version you are targeting.

mods.toml

toml

modLoader="javafml"
...
[[mods]]
...
[[dependencies.yourmod]]
    modId="voicechat_api"
    mandatory=true
    # Note that the mod ID "voicechat_api" was introduced with API version 2.6.0 - For older versions you need to depend on the mod ID "voicechat"
    versionRange="[${voicechat_api_version},)"
    ordering="AFTER"
    side="BOTH"

To register the voice chat plugin for a Forge mod, you need to create a class that implements de.maxhenkel.voicechat.api.VoicechatPlugin and has the annotation de.maxhenkel.voicechat.api.ForgeVoicechatPlugin.

TestPlugin.java

java

package com.example.yourmod;

import de.maxhenkel.voicechat.api.ForgeVoicechatPlugin;
import de.maxhenkel.voicechat.api.VoicechatPlugin;

@ForgeVoicechatPlugin
public class TestPlugin implements VoicechatPlugin {
    ...
}

To have Simple Voice Chat installed in your development environment, use the Modrinth Maven Repository. Alternatively use Cursemaven.

build.gradle

groovy

repositories {
    ...
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}
dependencies {
    ...
    // For Neoforge
    runtimeOnly "maven.modrinth:simple-voice-chat:neoforge-${voicechat_version}"
    // For Forge
    runtimeOnly "maven.modrinth:simple-voice-chat:forge-${voicechat_version}"
    // or Forge <1.20.6
    runtimeOnly fg.deobf("maven.modrinth:simple-voice-chat:forge-${voicechat_version}")
}

Bukkit/Spigot/Paper

To add the API dependency to your Bukkit/Spigot/Paper plugin add the following maven repository to your project.

build.gradle

groovy

repositories {
    ...
    maven { url = 'https://maven.maxhenkel.de/repository/public' }
}

In the dependencies section add the following maven dependency. Make sure voicechat_api_version is set to the voice chat API version you want to target. Available API versions can be found here.

build.gradle

groovy

dependencies {
    ...
    implementation "de.maxhenkel.voicechat:voicechat-api:${voicechat_api_version}"
}

To make your plugin depend on the voice chat plugin add the following to your plugin.yml.

plugin.yml

yaml

...
depend: [ voicechat ]

To register the voice chat plugin for a Bukkit/Spigot/Paper plugin, you need to create a class that implements de.maxhenkel.voicechat.api.VoicechatPlugin.

TestPlugin.java

java

package com.example.yourplugin;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}

Additionally, you need to register it in the BukkitVoicechatService.

java

package com.example.yourplugin;

import de.maxhenkel.voicechat.api.BukkitVoicechatService;
import org.bukkit.plugin.java.JavaPlugin;

public final class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        BukkitVoicechatService service = getServer().getServicesManager().load(BukkitVoicechatService.class);
        if (service != null) {
            service.registerPlugin(new TestPlugin());
        }
    }
    
    ...
}

Quilt

To add the API dependency to your Quilt mod, add the following maven repository to your project.

build.gradle

groovy

repositories {
    ...
    maven { url = 'https://maven.maxhenkel.de/repository/public' }
}

In the dependencies section add the following maven dependency. Make sure voicechat_api_version is set to the voice chat API version you want to target. Available API versions can be found here.

build.gradle

groovy

dependencies {
    ...
    implementation "de.maxhenkel.voicechat:voicechat-api:${voicechat_api_version}"
}

To avoid crashes due to outdated voice chat versions, make sure to add voicechat_api to the depends section in the quilt.mod.json. This prevents your mod from loading if versions of the voice chat are installed, that are older than the API version you are targeting.

quilt.mod.json

json

{
  "schemaVersion": 1,
  ...
  "depends": {
    ...
    {
      "id": "voicechat_api",
      "version": ">=${voicechat_api_version}"
    }
  }
}

To register the voice chat plugin for a Quilt mod, you need to create a class that implements de.maxhenkel.voicechat.api.VoicechatPlugin.

TestPlugin.java

java

package com.example.yourmod;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}

Additionally, you need to add a voicechat entrypoint in your quilt.mod.json, that refers to the class you just created.

quilt.mod.json

json

{
  "schemaVersion": 1,
  ...
  "entrypoints": {
    "init": [
      ...
    ],
    "voicechat": [
      "com.example.yourmod.TestPlugin"
    ]
  },
  ...
}

To have Simple Voice Chat installed in your development environment, use the Modrinth Maven Repository. Alternatively use Cursemaven.

build.gradle

groovy

repositories {
    ...
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}
dependencies {
    ...
    modRuntimeOnly "maven.modrinth:simple-voice-chat:quilt-${voicechat_version}"
}

Server Setup

Configuration

Getting Started

Starting From Scratch

With Existing Mods/Plugins

Fabric

Neoforge/Forge

Bukkit/Spigot/Paper

Quilt

Server Setup

Getting Started ​

Starting From Scratch ​

With Existing Mods/Plugins ​

Fabric ​

Neoforge/Forge ​

Bukkit/Spigot/Paper ​

Quilt ​

Getting Started

Starting From Scratch

With Existing Mods/Plugins

Fabric

Neoforge/Forge

Bukkit/Spigot/Paper

Quilt