OSCLeash 2.0

A VRChat OSC tool made with the intention to allow players to control another players moving, using an existing Physbone component in their model's armature.

Role: Python Developer | Client: Zenithval | Date: September 2nd, 2022

Project Overview

  • Project Type: App Development, Tool, Virtual Reality
  • Tools Used: Python, Unity3D, VrChat SDK, Open Sound Control (OSC)
  • Project Goals:
    • Restructure original code to follow best coding practices.
    • Find alternative solutions to tool functionality issues
    • Implement Object-Oriented Programming (OOP).
    • Implement the Single Responsibility Principle to the project's file structure.
    • Process OSC server data efficiently through the use of multithreading.
    • Update the code so multiple "leashes" can exist at the same time

The Problem / Challenge

The client, Zenithval, wanted to create a simple tool to increase the interactivity between users within the game called "VrChat". In summary, he wanted to give users the ability to pull or drag other users around. This functionality existed for specific "world" instances in VrChat, but only if it was implemented by the world creator. Zenithval wanted to give users the option to use this ability in any instance.

Therefore, he succeessfully created the original version of OSCLeash; Version 1.0 allowed a user to grab and pull a user. However, it had a number of issues such as:

  • Only 1 leash can exist at one time.
  • Arms and Legs did not move when being pulled; appearing stiff.
  • The model does not turn in the direction they are being pulled.
  • Error handling was not included.
  • The code was Flat or Monolithic, making it difficult to maintain.

The Process

Research

After understanding the existing problems in Version 1.0 of OSCLeash, I had dived into researching what modification were needed to complete Zenithval’s vision of the tool. I began by reading VRChat’s documentation on how to use OSC for VRChat. We were given the options of using either Python or C# to use OSC. Since version 1.0 was using the Python programming language, we decided to do the same for version 2.0.

As I was better prepared for this project, we began to tackle each primary problem individually.



Development


Add Multiple Leashes

To solve this issue, I had suggested adding a simple collection of any existing leashes where only one can be active at any time. All leashes will be grabbable; however, only one will affect the user at any time.

Stiff User Model

We found that this issue was related to VRChat itself and could not be changed. Therefore, Zenithval suggested emulating controller inputs into the game as it would result in movement that is like the OSC inputs. In conclusion, we decided to implement vgamepad to emulate a Virtual Gamepad through Python.

Model Turning

To include model turning, we had to know which way the leash was facing based on the user’s perspective. We had 4 points of reference that we were using to determine which direction to pull the user. Therefore, we decided to take advantage of those 4 points of reference and allowed the individual user to decide which of those 4 directions they should turn when a specific leash was pulled. These included North, West, South, and East. Additionally, we made this ability optional due to potential motion sickness.

Flat Code and Error Handling

To solve this specific issue, I had implemented the Single Responsibility Principle to the file structure, added error handling and tests whenever possible or necessary, and included a more detailed User Interface within the terminal. This allowed us to quickly find and resolve any coding issues that had arisen during development and user testing.

application terminal view

The Solution

To address the issues from OSCLeash version 1.0 and align with Zenithval's vision for version 2.0, I implemented key changes based on thorough research. The primary goals were to enhance user control, improve functionality, and create a more seamless experience for VRChat users. By focusing on the technical challenges and incorporating direct feedback from users, I was able to create a solution that not only met the original objectives but also provided greater customization and reliability in the tool's performance.

application terminal view

Key Features:

  • Multiple Leashes: Added support for a collection of leashes, where only one is active at any given time, improving flexibility while keeping the interface intuitive and manageable.
  • Virtual Gamepad Support: Used vgamepad to emulate controller inputs, compensating for VRChat's stiff user model and providing smoother, more accurate movement for the user.
  • User-Controlled Model Turning: Integrated a system to let users decide which direction to turn based on four reference points (North, West, South, East), with an option to disable it to avoid motion sickness.
  • Improved Error Handling: Implemented the Single Responsibility Principle in the file structure and added robust error handling and tests, ensuring faster problem resolution and greater code reliability.
  • Enhanced User Interface: Provided a more detailed terminal interface, improving transparency and ease of troubleshooting during development and user testing.
  • Modular Code Structure: Ensured the code was more flexible and scalable by adhering to clear coding principles, making future updates or modifications easier.

Interested in working together on a similar project?

Contact Me