Giter Club home page Giter Club logo

vrcft-babble's Introduction

VRCFT-Babble Module

Project Babble Module for VRCFaceTracking. An open-source VR mouth-tracking solution

image

Installation instructions

  1. Download and install Project Babble and VRCFaceTracking
  2. Download a copy of the latest release here
  3. Drop the VRCFaceTracking.Babble.dll file in AppData\Roaming\VRCFaceTracking\CustomLibs. If this folder does not exist you can create it, VRCFaceTracking will create it on launch
  4. Launch Project Babble, and set your outgoing port to 8888. You can do this via the GUI, or by editing the Python script directly. Also, be sure to orient your camera properly so your expressions aren't flipped in-game
  5. Launch VRCFT (v5!)
  6. Enable OSC in VRChat
  7. Equip a face-tracking avatar (one with unified expressions)
  8. Profit!

Thanks to Summer#2406, Rames The Generic#3540, DenTechs#9511, PLYSHKA#6201, and benaclejames#6822 for helping me test, and encouraging me to do this!

vrcft-babble's People

Contributors

amoenus avatar benaclejames avatar dangerkiddy avatar dfghiatus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

vrcft-babble's Issues

Configurable Host and Port for Babble Module

User Story

As a user running VRCFaceTracking (VRCFT) with the Babble module on a Cloud PC, I need the ability to configure the host and port settings of the BabbleOSC component. This will allow me to receive OSC data from my local computer, where Babble is running, to my Cloud PC via a public IP address, not just the loopback (127.0.0.1) IP.

Use Case

Scenario:

  1. Local Computer (Sender): A user is running Babble software that generates OSC data. This data needs to be sent to a remote Cloud PC.
  2. Cloud PC (Receiver): The Cloud PC is running VRCFaceTracking (VRCFT) with the Babble module, which listens for OSC data to drive face tracking features.

Current Limitation:

  • The BabbleOSC component is currently hardcoded to listen on the loopback IP address (127.0.0.1) and a fixed port (8888). This restricts the data flow to within the same machine, preventing communication across different machines.

Proposed Solution:

  • Modify the BabbleOSC component to accept configurable host and port settings. This will allow the user to specify the IP address and port on which the OSC data should be received, enabling communication over public IP addresses and different network segments.

Requirements

Configurable Host and Port:

  • Update the BabbleOSC constructor to accept both host and port parameters, with default values of "127.0.0.1" and 8888 respectively.
  • Ensure these parameters are used to bind the socket, allowing the component to listen on the specified IP address and port.
  1. Configuration:
    • Provide a documentation of how to change configuration or settings file where users can specify the desired host and port.

Benefits

  • Flexibility: Users can configure the host and port to match their network setup, allowing seamless integration between local and remote systems.
  • Remote Operation: Enables scenarios where the local machine generates data and the remote PC processes it
  • Improved User Experience: Simplifies the process of setting up VRCFT with Babble in diverse environments, making it more accessible and user-friendly.

Acceptance Criteria

  1. The BabbleOSC component must allow configuration of host and port parameters.
  2. The component should bind to the specified IP address and port correctly.
  3. Documentation must be updated to reflect the new configuration options.
  4. Users must be able to configure these settings through a user-friendly interface or configuration file.
  5. The system must handle incorrect configurations gracefully, providing meaningful error messages or fallbacks.

Crash on VRCFaceTracking >5.1.0.0

On VRCFaceTracking versions >=5.1.0.0 (i think), VRCFT will crash within a couple seconds of launching with the Babble plugin manually installed in Appdata\Roaming\VRCFaceTracking\CustomLibs.

I tested this on:
VRCFT v5.0.2.0 - Works
VRCFT v5.0.2.1 - Works
VRCFT v5.0.2.2 - Works
VRCFT v5.0.2.3 - Works
VRCFT v5.1.0.0 - Crash
VRCFT v5.1.1.0 - Crash
Using plugin version v2.1.0a

Video on VRCFT v5.1.0.0:
https://github.com/dfgHiatus/VRCFT-Babble/assets/59352535/dc4e2ade-bda1-41e8-8bf9-f95ec7f06415

Logs from VRCFT v5.1.0.0:
latest.log

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.