https://github.com/vavassor/paradraw

Drawing tools for visual debugging in VRChat worlds.
https://github.com/vavassor/paradraw

Last synced: about 2 months ago
JSON representation

Drawing tools for visual debugging in VRChat worlds.

• Host: GitHub
• URL: https://github.com/vavassor/paradraw
• Owner: Vavassor
• License: mit
• Created: 2024-05-10T13:29:10.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-25T22:07:43.000Z (5 months ago)
• Last Synced: 2024-07-26T00:32:36.325Z (5 months ago)
• Language: C#
• Homepage:
• Size: 714 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Discord - Community Chat](https://img.shields.io/badge/Discord-Community_Chat-7289da?logo=discord&logoColor=7289da)](https://discord.gg/XJYmP5dFJs) [![Website - Orchid Seal](https://img.shields.io/badge/Website-Orchid_Seal-af004f)](https://orchidseal.com/)

# ParaDraw

Drawing tools for visual debugging in [VRChat](https://vrchat.com) worlds.

Like [Unity Gizmos](https://docs.unity3d.com/ScriptReference/Gizmos.html) or [Debug.DrawLine](https://docs.unity3d.com/ScriptReference/Debug.DrawLine.html) but available at runtime so you can test in VR or on Android.

![Screenshot 2024-05-10 130229](https://github.com/Vavassor/ParaDraw/assets/8423688/f8fff229-9635-456e-8bc8-f2635c408543)

## Features

- Draw lines, rays, boxes, spheres, and cones.

- Control how long shapes are drawn for, to help see momentary events like raycasts.

- Line width and color options, to emphasize or fade away overlapping shapes.

## Getting Started

There's a few options to use the tools.

### Option 1 - Creator Companion

[Get the package for VRChat Creator Companion!](https://vavassor.github.io/OrchidSealVPM)

1. In the VPM repository, click "Add to VCC".

2. In Creator Companion, click the Manage Project button for your project.

3. Under "Manage Packages", find "ParaDraw" and click the add (+) button.

### Option 2 - Manual Install

Download the [latest Unity Package](https://github.com/vavassor/ParaDraw/releases/latest) and follow the directions for [importing local asset packages](https://docs.unity3d.com/2023.1/Documentation/Manual/AssetPackagesImport.html) into your Unity project.

### How to Use

Drag the ShapeDrawer prefab into your scene. ShapeDrawer is in the folder `Packages/ParaDraw/Runtime/Prefabs`.

Add the ShapeDrawer as a variable to any script you want to debug. And call whatever draw methods you like!

Check out the [Wiki](https://github.com/Vavassor/ParaDraw/wiki) for more guides!

## Frequently Asked Questions

### Question

Why do wireframe meshes looks broken on Quest?

#### Answer

Check the "Read/Write Enabled" option for the mesh in the [model import settings](https://docs.unity3d.com/Manual/FBXImporter-Model.html).

## License

This project is licensed under the terms of the [MIT license](LICENSE.md).