Skip to content

OSCQR

Jump to bottom
YUCP Creations edited this page Dec 13, 2024 · 1 revision

OSCQR Module Documentation

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

What is OSCQR?

The OSCQR module allows you to scan QR codes directly from your screen using Open Sound Control (OSC).

Features

  • Real-Time QR Code Detection: Automatically scans and detects QR codes from your screen.
  • Save and Manage QR Codes: Save detected QR codes for future reference.
  • Customizable Capture Settings: Select your preferred GPU and display.
  • Error Handling: Built-in error reporting through OSC parameters.

Installation

Step-by-Step Guide

  1. Download the Module:

    • Open VRCOSC and navigate to the "Downloads" tab.
    • Download Yeusepe's Module Repo.
    • Select the OSCQR module.

  2. Enable the Module:

    • Go to the "Modules" tab in VRCOSC.
    • Enable OSCQR from the list.

  3. Configure Settings (optional):

    • Default settings should work for most users, but you can manually configure GPU and display settings if needed.

Configuration

Default Configuration

  • The module is designed to work out of the box with automatic detection of GPU and display.
  • Start scanning by triggering the OSCQR/StartRecording parameter.

Advanced Configuration

  • To manually configure the module:
    1. Open the OSCQR settings panel in VRCOSC.
    2. Select your preferred Graphics Card and Display from the dropdown menus.
    3. Enable or disable saving debug images through the "Save Captured Images" toggle.

How to Use

Parameters

Parameter Description Mode
OSCQR/StartRecording Start or stop QR code scanning. Read/Write
OSCQR/QRCodeFound Indicates if a QR code has been detected. Write
OSCQR/ReadQRCode Saves the currently detected QR code. Read
OSCQR/Error Reports errors during operation. Write

Example Commands

  • To start scanning for QR codes:
    • Send true to the OSCQR/StartRecording parameter.
  • To stop scanning:
    • Send false to the OSCQR/StartRecording parameter.
  • To save a detected QR code:
    • Send true to the OSCQR/ReadQRCode parameter.

Troubleshooting

Common Issues

1. Display Not Detecting VRChat

  • Problem: The module fails to detect the display where VRChat is running.
  • Solution:
    1. Ensure VRChat is running and visible.
    2. Manually select your GPU and display in the OSCQR settings panel.
    3. Restart the module if changes are made.

2. QR Codes Not Detecting

  • Problem: QR codes are not being recognized.
  • Solution:
    1. Ensure the QR code is large and clear enough for detection.
    2. Increase the resolution or brightness of the QR code.
    3. Enable debug image saving to check if the captured frames are clear.

3. Error Parameter Active

  • Problem: The OSCQR/Error parameter is set to true.
  • Solution:
    1. Check the logs for specific error messages.
    2. Verify that GPU and display settings are correctly configured.
    3. Restart the module and try again.

Frequently Asked Questions (FAQ)

Does this module work with all GPUs?

Yes, but you may need to manually select your GPU and display in the settings panel if auto-detection fails.

Why isn’t my QR code being detected?

  • Ensure the QR code is in focus, well-lit, and has sufficient resolution.
  • Low-resolution or poorly printed QR codes may not be detected reliably.

Where can I get help?

Reach out to the discord for support.

Clone this wiki locally