https://github.com/VRLabs/Marker

A marker for drawing.
https://github.com/VRLabs/Marker

Last synced: about 1 month ago
JSON representation

A marker for drawing.

• Host: GitHub
• URL: https://github.com/VRLabs/Marker
• Owner: VRLabs
• License: mit
• Created: 2021-12-21T12:54:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-17T12:08:39.000Z (9 months ago)
• Last Synced: 2024-03-17T13:28:19.966Z (9 months ago)
• Language: C#
• Homepage:
• Size: 19 MB
• Stars: 74
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vrchat - Marker - A marker for drawing anywhere with your avatar (Tutorials / Avatars)

README

        


# Marker

[![Generic badge](https://img.shields.io/github/downloads/VRLabs/Marker/total?label=Downloads)](https://github.com/VRLabs/Marker/releases/latest)

[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/Marker/blob/main/LICENSE)

[![Generic badge](https://img.shields.io/badge/Quest-Partial%20Compatible-yellow?logo=Meta)](https://img.shields.io/badge/Quest-Partial%20Compatible-yellow?logo=Meta)

[![Generic badge](https://img.shields.io/badge/Unity-2022.3.22f1-lightblue?logo=Unity)](https://unity.com/releases/editor/whats-new/2022.3.22)

[![Generic badge](https://img.shields.io/badge/SDK-AvatarSDK3-lightblue.svg)](https://vrchat.com/home/download)

[![Generic badge](https://img.shields.io/discord/706913824607043605?color=%237289da&label=DISCORD&logo=Discord&style=for-the-badge)](https://discord.vrlabs.dev/)

[![Generic badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dvrlabs%26type%3Dpatrons&style=for-the-badge)](https://patreon.vrlabs.dev/)

A marker for drawing

![Marker-Draw](https://github.com/VRLabs/Marker/assets/76777936/e64f034a-f2a5-467a-b698-b383164e5422)

![Marker-Remove](https://github.com/VRLabs/Marker/assets/76777936/a6c657d3-19e1-4e59-950b-bf6d63096fd6)

### ⬇️ [Download Latest Version](https://github.com/VRLabs/Marker/releases/latest)

### 📦 [Add to VRChat Creator Companion](https://vrlabs.dev/packages?package=dev.vrlabs.marker)



---

## How it works

The "Draw" particle system emits particles for drawing. The "Eraser" collider kills the particles. Particles are emitted in a custom simulation space so the drawing can be manipulated.

## Install guide

https://user-images.githubusercontent.com/45078979/148662754-c6b64c0f-690f-495f-b012-f7da803c393e.mp4

Drag the Marker.cs script onto your avatar. You can customize settings for installing the marker. Some settings have tooltips for explanation.

After generating the marker, the ink and eraser emit from MarkerTarget.

Adjust the MarkerTarget transform by entering playmode with the emulator and enabling T-Pose Calibration. Enable the marker via its submenu. For the index finger setup, make sure MarkerTarget is positioned on the tip of your index finger. For the handheld pen setup, move and rotate MarkerTarget so your hand correctly holds the pen. MarkerTarget may also be freely scaled, if needed.

When finished adjusting MarkerTarget, copy its transform component to paste its values outside of playmode.

Click "Finish Setup" to finalize your marker and remove the script from your avatar.

> [!NOTE]  

> When building for Quest, you will have to remove unsupported components and shaders. The eraser does not work on Quest so drawings need to be cleared through the expression menu.

## Contributors

[ksivl](https://github.com/ksivl)

## License

Marker is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/Marker/blob/main/LICENSE).

​



[](https://vrlabs.dev "VRLabs")



[](https://discord.vrlabs.dev/ "VRLabs")



[](https://patreon.vrlabs.dev/ "VRLabs")



[](https://twitter.com/vrlabsdev "VRLabs")