DiscordOSC - Yeusepe/Yeusepes-Modules GitHub Wiki

DiscordOSC Module Documentation

Welcome to the documentation for the DiscordOSC module! This guide will walk you through the setup, configuration, and usage of this module.

What is DiscordOSC?

The DiscordOSC module bridges Discord with Open Sound Control (OSC), allowing you to control key Discord features directly from your OSC environment.

Features

  • Mute/Unmute Control: Toggle your microphone mute status in Discord via OSC.
  • Deafen/Undeafen Control: Manage your deafen status seamlessly.

Installation

Step-by-Step Guide

  1. Download the Module:

    • Open VRCOSC and go to the "Downloads" tab.
    • Find and download the Yeusepe's Module Repo.
    • Select the DiscordOSC module.

  2. Enable the Module:

    • Navigate to the "Modules" tab in VRCOSC.
    • Enable DiscordOSC from the list.

  3. Configuration (optional):

    • For most users, the module works without additional configuration.
    • If needed, enter your Discord Client ID and Client Secret in the settings panel.

Configuration

Default Configuration

The module is designed to function out of the box without requiring manual setup. Simply enable it in VRCOSC, and you're good to go!

Advanced Configuration (Optional)

If you encounter issues:

  1. Open the DiscordOSC settings panel in VRCOSC.
  2. Add your Discord Client ID and Client Secret.

How to Use

Parameters

Parameter Description Mode
VRCOSC/Discord/Mic Toggles mute/unmute. Read/Write
VRCOSC/Discord/Deafen Toggles deafen/undeafen. Read/Write

Example Commands

  • To mute your microphone:
    • Send false to the VRCOSC/Discord/Mic parameter.
  • To undeafen:
    • Send false to the VRCOSC/Discord/Deafen parameter.

Troubleshooting

Common Issues

  1. Module isn't working:

    • Ensure Discord is running on your computer.
    • Restart both Discord and VRCOSC.

  2. OSC commands not responding:

    • Verify your OSC setup is correct.
    • Check the logs for any errors and consult the VRCOSC community if needed.

  3. Authentication issues:

    • Add your Discord Client ID and Client Secret as described in the configuration section.

Frequently Asked Questions (FAQ)

Do I need to configure anything manually?

Not usually! The module is designed to work out of the box. Only add your Client ID and Client Secret if it doesn’t function as expected.

Where can I get help?

Reach out to the Discord!