### Add Simple Voice Chat Runtime Dependency (Forge/Neoforge Dev)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

For setting up a development environment with Simple Voice Chat installed, add the Modrinth Maven Repository to your build.gradle. Then, include the Simple Voice Chat mod itself as a runtimeOnly dependency, using `fg.deobf` for Forge to handle obfuscation. Replace `${voicechat_version}` with the desired mod version.

```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 fg.deobf("maven.modrinth:simple-voice-chat:forge-${voicechat_version}")
}
```

--------------------------------

### Setup ModRepo Project

Source: https://github.com/henkelmax/modrepo/blob/master/readme.md

This snippet provides the necessary commands to set up, develop, and build the ModRepo project locally. It covers installing dependencies, running a development server with hot reload, and creating a production build.

```bash
# Install dependencies
yarn install

# Serve with hot reload
yarn dev

# Build for production
yarn build
```

--------------------------------

### Importing Hoster Data (JavaScript)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/server_hosting/[hoster].md

Imports the 'data' object from the './hosters.data' file. This data likely contains information about different server hosters used by the page.

```JavaScript
import { data } from './hosters.data'
```

--------------------------------

### Add Modrinth Repository and Runtime Dependency to build.gradle (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds the Modrinth Maven repository to build.gradle and includes Simple Voice Chat as a `modRuntimeOnly` dependency. This setup is used to have the voice chat mod available in the development environment for testing.

```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}"
}
```

--------------------------------

### Vue Script Setup Initialization

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Initializes reactive variables using Vue's `ref` for managing popup visibility and the support key value. Imports the `ref` function from the 'vue' library.

```javascript
import { ref } from 'vue';

let supportKey = ref(generateSupportKey());
let showNotReadPopup = ref(false);
let showReadWikiPopup = ref(false);
let showSupportKeyPopup = ref(false);
```

--------------------------------

### Add Modrinth Maven Repository (Groovy)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds the Modrinth Maven repository to the build.gradle file. This repository is used to fetch the Simple Voice Chat mod itself for development environments, allowing you to test your API integration.

```Groovy
repositories {
    ...
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}
```

--------------------------------

### Implement VoicechatPlugin Interface (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Creates a Java class that implements the `de.maxhenkel.voicechat.api.VoicechatPlugin` interface. This class serves as the entry point for registering voice chat related functionality within the mod.

```Java
package com.example.yourmod;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}
```

--------------------------------

### Add Maven Repository to build.gradle (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds the public Maven repository from maxhenkel.de to the project's repositories block in build.gradle, allowing access to the voice chat API artifact.

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

--------------------------------

### Add Voice Chat Dependency Constraint (fabric.mod.json)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds a dependency entry for "voicechat" in the `depends` section of `fabric.mod.json`. This ensures that the mod will only load if a compatible version of Simple Voice Chat is installed, preventing crashes with older versions.

```JSON
{
  "schemaVersion": 1,
  ...
  "depends": {
    ...
    "voicechat": ">=${minecraft_version}-${voicechat_api_version}"
  }
}
```

--------------------------------

### Create Voice Chat Plugin Class (Java)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Defines a Java class that implements the `de.maxhenkel.voicechat.api.VoicechatPlugin` interface. This class serves as the main entry point for interacting with the Simple Voice Chat API from your mod.

```Java
package com.example.yourmod;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}
```

--------------------------------

### Register Voice Chat Entrypoint (fabric.mod.json)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds a "voicechat" entrypoint to the `entrypoints` section in `fabric.mod.json`. This entrypoint points to the custom class implementing `VoicechatPlugin`, allowing Simple Voice Chat to discover and load your plugin.

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

--------------------------------

### Add Simple Voice Chat API Maven Repository (Groovy)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds the public Maven repository hosted by maxhenkel.de to the project's build.gradle file, allowing access to the Simple Voice Chat API artifacts. This is a necessary step before declaring the API dependency.

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

--------------------------------

### Importing Data and Initializing Ref - Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/server_setup_mc_hosting.md

This script block imports the 'ref' function from Vue and 'data' from a local search index file. It then initializes a reactive reference named 'index' with the imported data, making it available for use in the component's template.

```JavaScript
import { ref } from 'vue'
import { data } from './server_hosting/search_index.data'

const index = ref(data)
```

--------------------------------

### Add Voicechat API Dependency (Forge/Neoforge)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

After adding the repository, declare the voicechat-api dependency in the dependencies block of your build.gradle. Replace `${voicechat_api_version}` with the specific API version you intend to target. This makes the API classes available to your mod during compilation.

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

--------------------------------

### Register Voice Chat Plugin Entrypoint in quilt.mod.json (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds a "voicechat" entrypoint to the `entrypoints` section in quilt.mod.json. This entrypoint specifies the fully qualified name of the class that implements `VoicechatPlugin`, allowing the voice chat mod to discover and load the plugin.

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

--------------------------------

### Add Simple Voice Chat API Dependency (Groovy)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Declares the Simple Voice Chat API as an implementation dependency in the build.gradle file. The `voicechat_api_version` variable should be set to the desired API version. This makes the API classes available to your mod.

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

--------------------------------

### Add Voicechat API Dependency (Bukkit/Spigot/Paper)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

After adding the repository, declare the voicechat-api dependency in the dependencies block of your build.gradle. Replace `${voicechat_api_version}` with the specific API version you intend to target. This makes the API classes available to your plugin during compilation.

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

--------------------------------

### Add Voice Chat API Dependency to build.gradle (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds the voicechat-api dependency to the project's dependencies block in build.gradle using the specified voicechat_api_version. This makes the API classes available for compilation.

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

--------------------------------

### Implement Voicechat Plugin Class (Bukkit/Spigot/Paper)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To create your custom voice chat plugin implementation for Bukkit/Spigot/Paper, create a Java class that implements the `de.maxhenkel.voicechat.api.VoicechatPlugin` interface. This class will contain the logic for your voice chat integration.

```Java
package com.example.yourplugin;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}
```

--------------------------------

### Check Wiki Read Status (Vue.js)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Defines a function to determine if the user has visited the required wiki pages. It parses the 'visitedTabs' item from `localStorage` and checks if the 'setup', 'troubleshooting', and 'faq' identifiers are present in the stored array.

```javascript
function hasReadWiki() {
    const visitedTabs = JSON.parse(localStorage.visitedTabs || '[]');
    return visitedTabs.includes("setup") && visitedTabs.includes("troubleshooting") && visitedTabs.includes("faq");
}
```

--------------------------------

### Register Voicechat Plugin Class (Forge/Neoforge)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To register your custom voice chat plugin implementation for Forge/Neoforge, create a Java class that implements the `de.maxhenkel.voicechat.api.VoicechatPlugin` interface. Crucially, this class must be annotated with `@de.maxhenkel.voicechat.api.ForgeVoicechatPlugin` to be discovered and loaded by Simple Voice Chat.

```Java
package com.example.yourmod;

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

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

--------------------------------

### Add Voicechat API Maven Repository (Forge/Neoforge)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To add the Simple Voice Chat API dependency to your Forge or Neoforge mod, include the public Maven repository hosted by maxhenkel.de in your build.gradle file's repositories block. This allows your build system to locate and download the API artifact.

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

--------------------------------

### Add Voicechat API Maven Repository (Bukkit/Spigot/Paper)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To add the Simple Voice Chat API dependency to your Bukkit, Spigot, or Paper plugin, include the public Maven repository hosted by maxhenkel.de in your build.gradle file's repositories block. This allows your build system to locate and download the API artifact.

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

--------------------------------

### Add Voicechat Dependency to plugin.yml (Bukkit/Spigot/Paper)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To declare that your Bukkit/Spigot/Paper plugin depends on Simple Voice Chat, add 'voicechat' to the 'depend' list in your plugin.yml file. This ensures that Simple Voice Chat is loaded before your plugin, preventing potential startup issues.

```YAML
...
depend: [ voicechat ]
```

--------------------------------

### Register Voicechat Plugin Service (Bukkit/Spigot/Paper)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

In your main Bukkit/Spigot/Paper plugin class, typically within the `onEnable` method, retrieve the `BukkitVoicechatService` from the server's services manager. If the service is available, register an instance of your `VoicechatPlugin` implementation with it. This makes your plugin known to Simple Voice Chat.

```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());
        }
    }
    
    ...
}
```

--------------------------------

### Add Simple Voice Chat Runtime Dependency (Groovy)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Declares the Simple Voice Chat mod as a `modRuntimeOnly` dependency in build.gradle. This makes the mod available during development and testing but does not include it in the final mod distribution. The `voicechat_version` variable should specify the mod version.

```Groovy
dependencies {
    ...
    modRuntimeOnly "maven.modrinth:simple-voice-chat:fabric-${voicechat_version}"
}
```

--------------------------------

### Rendering Client-Side Component - Vue Template

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/server_setup_mc_hosting.md

This code snippet uses the Vue <ClientOnly> wrapper component. It ensures that the component nested inside it, <WikiTracker name="setup"/>, is only rendered on the client side after the initial server-side rendering (SSR) hydration, preventing potential SSR issues.

```Vue
<ClientOnly>
    <WikiTracker name="setup"/>
</ClientOnly>
```

--------------------------------

### Setting Voice Chat Port

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/server_setup.md

Example configuration setting to change the voice chat server port in the mod's server configuration file. This line should be added or modified in the server config.

```Configuration
port=24454
```

--------------------------------

### Add Voice Chat Dependency to quilt.mod.json (Quilt)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

Adds a dependency entry for "voicechat" in the quilt.mod.json file. This ensures the mod requires a compatible version of Simple Voice Chat to prevent crashes with outdated versions. The version constraint uses placeholders for minecraft_version and voicechat_api_version.

```JSON
{
  "schemaVersion": 1,
  ...
  "depends": {
    ...
    {
      "id": "voicechat",
      "version": ">=${minecraft_version}-${voicechat_api_version}"
    }
  }
}
```

--------------------------------

### Add Voicechat Dependency to mods.toml (Forge/Neoforge)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/getting_started.md

To ensure compatibility and prevent crashes with outdated voice chat versions, add a mandatory dependency entry for 'voicechat' in your mod's mods.toml file. Configure the versionRange to require a version compatible with your targeted API version. This ensures your mod only loads when a suitable Simple Voice Chat version is present.

```TOML
modLoader="javafml"
...
[[mods]]
...
[[dependencies.yourmod]]
    modId="voicechat"
    mandatory=true
    versionRange="[${minecraft_version}-${voicechat_api_version},)"
    ordering="AFTER"
    side="BOTH"
```

--------------------------------

### Example Moved Config File (TOML)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/troubleshooting.md

This snippet shows the content of an old configuration file after the config location was changed in version 2.4.0+. It indicates that the config has been moved and points to the new location.

```toml
# This config has been moved to config/voicechat/voicechat-client.properties
moved = true
```

--------------------------------

### Button Styling (CSS)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Provides scoped CSS rules to style the 'Generate a support key' button. It defines properties for appearance (border-radius, background, padding, color) and layout (display, justify-content), including a hover effect.

```css
.button {
    border-radius: 8px;
    background-color: var(--vp-c-brand);
    padding: 0.5rem;
    display: flex;
    justify-content: center;
    transition: all 0.2s ease-in-out;
    color: #fff;
}

.button:hover {
    background-color: #3da170;
}
```

--------------------------------

### Defining FAQ Data in Vue.js Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/gravestone/faq.md

This JavaScript snippet, used within a Vue.js `<script setup>` block, defines an array of objects. Each object represents a single FAQ entry, containing a 'question' and its corresponding 'answer'. This array is likely passed as a prop to a component (like `<FAQ>`) to render the FAQ list dynamically.

```javascript
const faq = [
  {
    question: "I can't find the gravestone after I died.",
    answer:
      "If you died in a wall, there is a high chance that the gravestone is placed at the next free spot above your death location.",
  },
  {
    question: "How can I get rid of the beacon on my death location?",
    answer:
      "There is no beacon in this mod. This is most likely from a minimap mod.",
  },
];
```

--------------------------------

### Declaring Credits Array in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/easy_piglins/credits.md

This JavaScript snippet defines an array named `credits` within a Vue `<script setup>` block. The array contains objects, each representing a contributor with details about their translation work and a link to their GitHub profile. This data is intended to be passed as a prop to the `<Credits>` component.

```JavaScript
const credits = [
  {
    element: { name: "Brazilian Portuguese translation" },
    name: {
      name: "Mikeliro",
      link: "https://github.com/Mikeliro",
    },
  },
  {
    element: { name: "Korean translation" },
    name: {
      name: "hayanggom",
      link: "https://github.com/hayanggom",
    },
  },
  {
    element: { name: "Chinese (Simplified) translation" },
    name: {
      name: "Yanang Pearce",
      link: "https://github.com/yanang007",
    },
  },
  {
    element: { name: "Japanese translation" },
    name: {
      name: "ALFEECLARE",
      link: "https://github.com/ALFEECLARE",
    },
  },
  {
    element: { name: "Ukrainian translation" },
    name: {
      name: "KoshaSigma",
      link: "https://github.com/KoshaSigma",
    },
  },
  {
    element: { name: "Ukrainian translation" },
    name: {
      name: "Andrij Zyniuk",
      link: "https://github.com/pgmtags",
    },
  },
  {
    element: { name: "Turkish translation" },
    name: {
      name: "RuyaSavascisi",
      link: "https://github.com/RuyaSavascisi",
    },
  },
  {
    element: { name: "Chinese Traditional translation" },
    name: {
      name: "dirtTW",
      link: "https://github.com/yichifauzi",
    },
  },
];
```

--------------------------------

### Get Random Integer (JavaScript)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Defines a helper function to generate a random integer within a specified minimum and maximum range, inclusive. It uses `Math.random()`, `Math.floor()`, and `Math.ceil()` to ensure the result is an integer within the bounds.

```javascript
function getRandomInt(min, max) {
    min = Math.ceil(min);
    max = Math.floor(max);
    return Math.floor(Math.random() * (max - min + 1)) + min;
}
```

--------------------------------

### Configuring a Redirect with React Router

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/easy_villagers/faq.md

This snippet uses a Redirect component to automatically navigate the user from the current path to '/minecraft/faq'. This is typically used within a routing configuration to handle deprecated paths or simple aliases.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Handle Support Key Button Click (Vue.js)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Defines the function executed when the 'Generate a support key' button is clicked. It checks if the user has read the required wiki pages using `hasReadWiki()` and sets the appropriate reactive variable to show either the 'read wiki' confirmation popup or the 'not read' warning popup.

```javascript
function clickSupportKey() {
    if( hasReadWiki() ){
        showReadWikiPopup.value = true;
    } else{
        showNotReadPopup.value = true;
    }
}
```

--------------------------------

### Defining FAQ Data in Vue.js Setup Script

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/faq.md

This JavaScript code defines an array of objects, where each object represents a question and its corresponding answer for the FAQ section. This array is intended to be used by a Vue.js component to render the FAQ list dynamically.

```JavaScript
const faq = [
  {
    question: "How do I get my logs?",
    answer: 'Read <a href="/minecraft/how_to_get_logs">this</a>.',
  },
  {
    question: "Why am I getting 'Voice chat not connected'?",
    answer: 'You may have not opened the voice chat port on your server. If you are renting a Minecraft server you may need some special configuration. Read the <a href="/minecraft/voicechat/wiki/setup">wiki</a> for more information.',
  },
  {
    question: "I opened the port. Why is it still not working?",
    answer: 'Most hosters require a special setup besides port forwarding. Read the <a href="/minecraft/voicechat/wiki/setup">wiki</a> for more information.',
  },
  {
    question: "How do I open the voice chat port?",
    answer: `
If you are hosting your server with a Minecraft hosting provider, please take look at <a href="/minecraft/voicechat/wiki/server_setup_mc_hosting">this</a>.
If your hoster is not listed here, please ask the support of your hoster for help.
<br/>
If you are hosting the server on your local machine or a self hosted server, take a look at <a href="/minecraft/voicechat/wiki/server_setup_self_hosted">this</a>.
`,
  },
  {
    question: "How can I submit a setup guide for a specific server hoster?",
    answer: 'Read <a href="/minecraft/voicechat/wiki/submit_hoster">this</a>.',
  },
  {
    question: "Can vanilla clients still join when the voice chat mod is installed on the server?",
    answer: "Yes, vanilla clients can join the server, as long as you haven't enabled the option <code>force_voice_chat</code> in the voice chat server config.",
  },
  {
    question: "Does this work with LAN worlds/singleplayer?",
    answer: "Yes, you can use the voice chat in singleplayer and in LAN worlds. But it's recommended to use a dedicated server if you want to play with other people.",
  },
  {
    question: "Am I allowed to use this mod in a modpack?",
    answer: "Yes. But please make sure to give credit.",
  },
  {
    question: "Does the mod/plugin also need to be installed on the server for it to work?",
    answer: "Yes! You can still join servers without the mod installed on your server, but you won't be able to use any of the mod's features.",
  },
  {
    question: "Does the mod also need to be installed on the client for it to work?",
    answer: "You can still join servers without the mod installed on your client, but you won't be able to use any of the mod's features.",
  },
  {
    question: "Can I join a server that uses another mod loader than my client?",
    answer: "Yes, all mod/plugin loaders are cross compatible.",
  },
  {
    question: "Does this work on Realms?",
    answer: "No. Realms can't be modded.",
  },
  {
    question: "Does this work on Bedrock edition?",
    answer: "No. Only on Java edition. It is impossible to implement a voice chat in bedrock edition due to technical limitations.",
  },
  {
    question: "Does this mod require something like Discord or Mumble installed?",
    answer: "No. It works completely standalone.",
  },
  {
    question: "Are different mod/plugin versions compatible with each other?",
    answer: 'Sometimes yes. But to have the best experience, it is recommended to use the exact same version on all clients and the server. For more information read <a href="/minecraft/voicechat/wiki/compatibility">this</a>.',
  },
  {
    question: "Does every player need to open the voice chat port?",
    answer: "No. Only the server needs to have the port open.",
  },
  {
    question: "Does this work with ngrok?",
    answer: "No. Ngrok does not support UDP.",
  },
  {
    question: "Does this work with Mohist/Arclight/Magma/Cardboard or any other hybrid server?",
    answer: `We generally don't provide support any hybrid servers. For more information read <a href="https://essentialsx.net/do-not-use-mohist.html">this</a>.`,
  },
  {
    question: "Are custom clients supported?",
    answer: `We do not provide support for custom clients.`,
  },
  {
    question: "Does this work with tunneling or world hosting services like playit.gg, Essential, e4mc, World Host or Localtonet?",
    answer: `These services are not officially supported, as these setups are overly complex, require advanced technical expertise, and are prone to configuration errors.`,
  },
  {
    question: "Does this mod work with TCPShield?",
    answer: `Yes, but only with their paid plan and you need to contact their support.`,
  },
  {
    question: "Does the voice chat activate Sculk sensors?",
    answer: `Not by default. You need to install an <a href="https://modrinth.com/mod/voice-chat-interaction">additional mod</a> to add this feature.`,
  },
  {
    question: "Can I request new features?",

```

--------------------------------

### Redirecting to Modrinth URL (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/downloads/velocity.md

This snippet uses a Redirect component, commonly found in routing libraries for web frameworks, to perform an immediate navigation to the specified URL. The 'path' prop defines the target URL.

```JSX
<Redirect path="https://modrinth.com/plugin/simple-voice-chat/versions?loader=velocity#download"/>
```

--------------------------------

### Generate Support Key (JavaScript)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/support.md

Defines a function that generates a support key string. It repeatedly adds random integers (1-9) to a list until their sum exceeds 60, then adds the remainder needed to reach 69, and formats the result as 'S-' followed by the concatenated numbers.

```javascript
function generateSupportKey() {
    let numbers = [];
    let sum = 0;
    while (sum <= 60) {
      numbers.push(getRandomInt(1, 9));
      sum = numbers.reduce((e1, e2) => e1 + e2, 0);
    }
    let rest = 69 - sum;
    if (rest > 0) {
      numbers.push(rest);
    }
    return `S-${numbers.join('')}`;
}
```

--------------------------------

### Configuring Path Redirect with JSX

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/camerautils/faq.md

Configures a client-side redirect from the specified path '/minecraft/faq'. This component is typically used within a routing setup to automatically navigate the user to a different route when the source path is matched.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Defining Credits Array in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/old_credits.md

This snippet defines a JavaScript array named `credits` within a Vue `<script setup>` block. The array contains objects representing credits for various components or contributions, including links to repositories and licenses. This data is intended to be passed as a prop to the `<Credits>` component.

```JavaScript
const credits = [
  {
    element: {
      name: "RNNoise natives",
      link: "https://github.com/mjwells2002/rnnoise-bin",
    },
    name: {
      name: "mjwells2002",
      link: "https://github.com/mjwells2002",
    },
  },
  {
    element: {
      name: "Opus natives",
      link: "https://github.com/mjwells2002/libopus-bin",
    },
    name: {
      name: "mjwells2002",
      link: "https://github.com/mjwells2002",
    },
  },
  {
    element: { name: "Opus natives for ARM based macs" },
    name: {
      name: "jason-green-io",
      link: "https://github.com/jason-green-io",
    },
  },
  {
    element: {
      name: "dd-plist",
      link: "https://github.com/3breadt/dd-plist",
    },
    license: {
      name: "Custom",
      link: "https://github.com/3breadt/dd-plist/blob/master/LICENSE.txt",
    },
  },
  {
    element: {
      name: "MacOS microphone workaround",
    },
    name: {
      name: "mjwells2002",
      link: "https://github.com/mjwells2002",
    },
  },
  {
    element: {
      name: "MacOS microphone workaround",
    },
    name: {
      name: "cbyrneee",
      link: "https://github.com/cbyrneee",
    },
  },
];
```

--------------------------------

### Redirecting Route with React/JSX

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/mining_dimension/faq.md

This snippet defines a route that, when matched, automatically redirects the user to a different path. It uses a `Redirect` component, commonly found in routing libraries like React Router, to perform the redirection from `/minecraft/faq` to another location.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Defining Credits Data in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/trade_cycling/credits.md

This JavaScript code defines an array named `credits` within a Vue `<script setup>` block. Each object in the array represents a credit, specifying the credited element (like a translation) and the contributor's name and a link to their profile. This array is intended to be passed as a prop to a component, likely for rendering a list of credits.

```javascript
const credits = [
  {
    element: { name: "Mexican Spanish translation" },
    name: {
      name: "CANALETA",
      link: "https://github.com/CANALETA",
    },
  },
  {
    element: { name: "Traditional Chinese translation" },
    name: {
      name: "dirtTW",
      link: "https://github.com/yichifauzi",
    },
  },
  {
    element: { name: "Portuguese translation" },
    name: {
      name: "WingFrosty",
      link: "https://github.com/WingFrosty",
    },
  },
  {
    element: { name: "Turkish translation" },
    name: {
      name: "Hexasan",
      link: "https://github.com/Hexasan",
    },
  },
];
```

--------------------------------

### Force Bukkit Compatibility - Shell

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/force_bukkit_compatibility.md

This command demonstrates how to start a Bukkit server JAR while setting the 'voicechat.compatibility' Java system property. This property forces the Simple Voice Chat plugin to assume compatibility with the specified Bukkit version string, overriding automatic detection. Replace '1.21.5-R0.1-SNAPSHOT' with the desired Bukkit version and 'bukkit.jar' with your server JAR file name.

```sh
java -Dvoicechat.compatibility="1.21.5-R0.1-SNAPSHOT" -jar bukkit.jar
```

--------------------------------

### Redirecting Path using XML/JSX

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/downloads/bungeecord.md

This snippet defines a redirect rule using an XML-like <Redirect> component. It specifies a destination URL in the 'path' attribute, indicating where a user should be redirected when this rule is triggered, likely within a routing setup.

```XML
<Redirect path="https://modrinth.com/plugin/simple-voice-chat/versions?loader=bungeecord#download"/>
```

--------------------------------

### Configuring Root Path Redirect (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/pipez/faq.md

This snippet uses a <Redirect> component, typically found in routing libraries like React Router, to automatically navigate the user from the root path ('/') to '/minecraft/faq'. This component should be placed within a routing context (e.g., inside a <Switch> or <Routes> component depending on the library version) to be effective. It requires the specific routing library to be installed and configured in the application.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Example using Stick and Wood Box (Short/Long Fields)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/peek/wiki/data_strings.md

Demonstrates using data strings to display a stick item and the label 'Wood Box' on a shulker box lid, showing both short ('i', 'l') and long ('item', 'label') field names within the curly brackets.

```Custom Format
Wooden stuff {i=stick;l=Wood Box}
```

```Custom Format
Wooden stuff {item=stick;label=Wood Box}
```

--------------------------------

### Redirecting a Path with React Router (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/storage_overhaul/faq.md

This snippet utilizes the React Router `<Redirect>` component to automatically redirect requests from the specified `path` (`/minecraft/faq`). The destination path is typically provided via a `to` prop, which is not shown here, suggesting it might redirect to the same path or the context implies the destination.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Example using Stone and Rocks (Short/Long Fields)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/peek/wiki/data_strings.md

Demonstrates using data strings to display a stone item and the label 'Rocks' on a shulker box lid, showing both short ('i', 'l') and long ('item', 'label') field names within the curly brackets.

```Custom Format
My Box {i=stone;l=Rocks}
```

```Custom Format
My Box {item=stone;label=Rocks}
```

--------------------------------

### Playing Audio to Channel with VoicechatServerApi (Java)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/examples.md

Explains how to play audio samples (48kHz 16-bit PCM) to any type of audio channel (Static, Locational, Entity) using the VoicechatServerApi. It covers creating an AudioPlayer, starting and stopping playback, checking the player's status, and setting a callback for when playback finishes or is stopped. Notes that playback occurs in a separate thread.

```java
VoicechatServerApi api = ...;
LocationalAudioChannel channel = ...; // Can also be a StaticAudioChannel or EntityAudioChannel
short[] audio = ...; // The audio samples in 48kHz 16-bit PCM format

AudioPlayer player = api.createAudioPlayer(channel, api.createEncoder(), audio);
player.startPlaying();

...

player.stopPlaying(); // Stop playing the audio
player.isPlaying(); // Returns true if the audio is currently playing
player.isStopped(); // Returns true if the audio is finished playing or was stopped

player.setOnStopped(() -> {
    // This will be called once the audio is finished playing or was stopped
});
```

--------------------------------

### Define Credits and Translations Data in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/credits.md

This script block defines two constant arrays, `credits` and `translations`, which hold structured data about project dependencies, contributors, links, and licenses. This data is likely used by the `<Credits>` component to render the information dynamically.

```JavaScript
const credits = [
  {
    element: { name: "Icons" },
    name: {
      name: "Stridey",
      link: "https://www.planetminecraft.com/member/stridey/",
    },
  },
  {
    element: { name: "Proxy plugins" },
    name: {
      name: "Nila",
      link: "https://github.com/nilathedragon",
    },
  },
  {
    element: {
      name: "Opus Codec",
      link: "https://opus-codec.org/",
    },
    license: {
      name: "3-Clause BSD License",
      link: "https://opus-codec.org/license/",
    },
  },
  {
    element: {
      name: "RNNoise",
      link: "https://jmvalin.ca/demo/rnnoise/",
    },
    license: {
      name: 'BSD 3-Clause "New" or "Revised" License',
      link: "https://gitlab.xiph.org/xiph/rnnoise/-/blob/master/COPYING",
    },
  },
  {
    element: {
      name: "LAME",
      link: "https://lame.sourceforge.io/",
    },
    license: {
      name: "GNU LIBRARY GENERAL PUBLIC LICENSE Version 2",
      link: "https://sourceforge.net/p/lame/svn/HEAD/tree/tags/RELEASE__3_100/lame/COPYING",
    },
  },
  {
    element: {
      name: "adventure",
      link: "https://github.com/KyoriPowered/adventure",
    },
    license: {
      name: "MIT",
      link: "https://github.com/KyoriPowered/adventure/blob/master/license.txt",
    },
  },
  {
    element: {
      name: "commodore",
      link: "https://github.com/lucko/commodore",
    },
    license: {
      name: "MIT",
      link: "https://github.com/lucko/commodore/blob/master/LICENSE.txt",
    },
  },
  {
    element: {
      name: "Concentus",
      link: "https://github.com/lostromb/concentus",
    },
    license: {
      name: "Custom",
      link: "https://github.com/lostromb/concentus/blob/master/LICENSE",
    },
  },
  {
    element: {
      name: "Fabric API",
      link: "https://github.com/FabricMC/fabric",
    },
    license: {
      name: "Apache License 2.0",
      link: "https://github.com/FabricMC/fabric/blob/1.20.1/LICENSE",
    },
  },
  {
    element: {
      name: "Quilt Standard Libraries (QSL)",
      link: "https://github.com/QuiltMC/quilt-standard-libraries",
    },
    license: {
      name: "Apache License 2.0",
      link: "https://github.com/QuiltMC/quilt-standard-libraries/blob/1.20/LICENSE",
    },
  },
  {
    element: {
      name: "Quilted Fabric API",
      link: "https://github.com/QuiltMC/quilted-fabric-api",
    },
    license: {
      name: "Apache License 2.0",
      link: "https://github.com/QuiltMC/quilted-fabric-api/blob/1.20.1/LICENSE",
    },
  }
];

const translations = [
  {
    element: { name: "Brazilian Portuguese translation" },
    name: {
      name: "Allomere",
      link: "https://github.com/Allomere",
    },
  },
  {
    element: { name: "Italian translation" },
    name: {
      name: "UknownGino",
      link: "https://github.com/UknownGino",
    },
  },
  {
    element: { name: "Dutch translation" },
    name: {
      name: "emielderckx",
      link: "https://github.com/emielderckx",
    },
  },
  {
    element: { name: "Chinese Simplified (China) translation" },
    name: {
      name: "MikhailTapio",
      link: "https://github.com/MikhailTapio",
    },
  },
  {
    element: { name: "Russian translation" },
    name: {
      name: "Strongleong",
      link: "https://github.com/Strongleong",
    },
  },
  {
    element: { name: "Catalan translation" },
    name: {
      name: "JoanVC100",
      link: "https://github.com/JoanVC100",
    },
  },
  {
    element: { name: "Polish translation" },
    name: {
      name: "RDKRACZ",
      link: "https://github.com/RDKRACZ",
    },
  },
  {
    element: { name: "Spanish translation" },
    name: {
      name: "zeedif",
      link: "https://github.com/zeedif",
    },
  },
  {
    element: { name: "Russian translation" },
    name: {
      name: "DrHesperus",
      link: "https://github.com/DrHesperus",
    },
  },
  {
    element: { name: "Swedish translation" },
    name: {
      name: "TechnicProblem",
      link: "https://github.com/TechnicProblem",
    },
  },
  {
    element: { name: "Ukrainian translation" },
    name: {
      name: "ProSplash1",
      link: "https://legacy.curseforge.com/members/prosplash1",
    },
  },
  {
    element: { name: "Japanese translation" },
    name: {
      name: "shonkei",
      link: "https://github.com/shonkei",
    },
  },
  {
    element: { name: "Chinese Simplified (China) translation" },
    name: {
      name: "XmLinkia",
      link: "https://github.com/XmLinkia",
    },
  },
  {
    element: { name: "Korean translation" },
    name: {
      name: "gyular",
      link: "https://github.com/gyular",
    },
  },
  {
    element: { name: "Polish translation" },
    name: {
      name: "joker876",
      link: "https://github.com/joker876",
    },
  },
  {
    element: { name: "Czech translation" },
    name: {
      name: "HonzaVinCZ",
      link: "https://github.com/HonzaVinCZ",
    },
  },
  {

```

--------------------------------

### Using React Router Redirect Component - JavaScript

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/better_respawn/faq.md

This snippet shows how to use the Redirect component from a routing library like React Router to automatically navigate the user from the current path to a new one. It is typically used within a Switch or Routes component to handle specific path matching.

```JavaScript
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Redirecting a Path using React Router JSX

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/reap/faq.md

This snippet shows how to use the Redirect component from React Router to automatically navigate a user from a specific path (`/minecraft/faq`) to another route. This is typically used within a Switch or Routes component to define navigation rules.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Implementing initialize Method (Java)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/your_plugin.md

Shows the `initialize` method, which is called when the plugin is loaded. This method provides access to the `VoicechatApi` instance for interacting with the voice chat functionality.

```Java
@Override
public void initialize(VoicechatApi api) {
    ...
}
```

--------------------------------

### Configuring a Route Redirect (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/setup.md

Sets up a redirect from the current path to the specified path "server_setup". This is typically used within a routing component like <Switch> or <Routes> to handle navigation changes.

```JSX
<Redirect path="server_setup"/>
```

--------------------------------

### Defining Credits Data in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/renderdistance/credits.md

This JavaScript snippet defines an array of credit objects within a Vue 3 `<script setup>` block. This data is intended to be passed as a prop to a component, likely for rendering a list of contributors.

```javascript
const credits = [
  {
    element: { name: "Simulation/Render distance ratio" },
    name: {
      name: "GotoFinal",
      link: "https://github.com/GotoFinal",
    },
  },
];
```

--------------------------------

### Implementing VoicechatPlugin Interface (Java)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/your_plugin.md

Shows the basic structure of a class implementing the `VoicechatPlugin` interface, which serves as the main entry point for voice chat plugins across different mod/plugin loaders.

```Java
package com.example.yourmod;

import de.maxhenkel.voicechat.api.VoicechatPlugin;

public class TestPlugin implements VoicechatPlugin {
    ...
}
```

--------------------------------

### Defining Credits Array in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/fakeblocks/credits.md

Defines a reactive array `credits` within a Vue 3 `<script setup>` block. This array holds objects representing contributors and their contributions, intended to be passed as a prop to the `<Credits>` component.

```javascript
const credits = [
  {
    element: { name: "Brazilian Portuguese translation" },
    name: {
      name: "Mikeliro",
      link: "https://github.com/Mikeliro",
    },
  },
];
```

--------------------------------

### Redirecting Root Path to Wiki Overview (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/peek.md

This snippet uses a Redirect component (likely from a routing library like React Router) to automatically navigate users from the application's root path ('/') to the specified path 'peek/wiki/overview'. This is typically used to set a default landing page.

```JSX
<Redirect path="peek/wiki/overview"/>
```

--------------------------------

### Redirecting to a Specific Path in JavaScript

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki/index.md

This snippet shows how to use a Redirect component to automatically navigate the user to the '/installation' path. This is typically used in routing configurations to handle redirects based on certain conditions or default routes.

```JavaScript
<Redirect path="installation"/>
```

--------------------------------

### Defining Credits Array in Vue Script Setup

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/advancedtools/credits.md

This JavaScript snippet defines a constant array named `credits` within a Vue 3 `<script setup>` block. This array holds objects representing individual credits, including the element name and the contributor's name and link. This data is intended to be passed as a prop to a component like `<Credits/>` for rendering.

```javascript
const credits = [
  {
    element: { name: "Pliers texture" },
    name: {
      name: "usernameye",
      link: "https://github.com/usernameye",
    },
  },
];
```

--------------------------------

### Creating Group with VoicechatServerApi (Java)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api/examples.md

Demonstrates how to use the VoicechatServerApi to build and create a group with specific properties like persistence, name, password, and type. Explains that persistent groups are created immediately upon calling build(), while non-persistent groups are created when the first player is added.

```java
VoicechatServerApi api = ...;

Group group = api.groupBuilder()
        .setPersistent(true) // Doesn't remove the group once all players left
        .setName("My Persistent Group") // The name of the group
        .setPassword("SuperSecretPassword") // The password of the group
        .setType(Group.Type.ISOLATED) // The type of the group (NORMAL, OPEN, ISOLATED)
        .build();
```

--------------------------------

### Configuring Route Redirect with Redirect Component (JSX)

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/easy_piglins/faq.md

This snippet demonstrates how to set up a client-side route redirect using a component like `Redirect`. When the path `/minecraft/faq` is matched, the user will be automatically redirected to another location (though the target isn't explicitly shown in this snippet, the component's purpose is redirection). This is commonly used in routing libraries like React Router.

```JSX
<Redirect path="/minecraft/faq"/>
```

--------------------------------

### Using Redirect Component in JSX

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/api.md

This snippet shows how to use a Redirect component to configure a route that redirects from the current path to the specified 'path'. This is commonly used for simple URL redirects within a client-side routing setup.

```JSX
<Redirect path="api/overview"/>
```

--------------------------------

### Configuring a Redirect using Redirect Component

Source: https://github.com/henkelmax/modrepo/blob/master/docs/minecraft/voicechat/wiki.md

This snippet shows how to use a Redirect component to automatically navigate the user from one path to another. It's commonly used for setting up default routes or handling old URLs.

```JavaScript
<Redirect path="wiki/installation"/>
```