Skip to content

halomakes/GravyVrc.Summoner

Repository files navigation

Summoner Logo

GravyVRC Summoner

Control your VRChat avatar with NFC tags!

Windows Store Release Build Test Build

Hardware

Summoner was developed against this hardware. I cannot guaruntee compatibility with other scanners/tags.

You should be able to find these easily on your favorite online marketplace.

Installation

Microsoft Store

The easiest way to install Summoner is via the Microsoft Store. Currently there is an issue where the app crashes instantly when installed from the store. See #17. Get it from the Microsoft Store

Manual Installation

You can also head to the releases page and download non-packaged builds for your platform from there.

Usage

image

Click Add Parameter to add parameters to set on your avatar anytime the tag is scanned while the app is open.

image

Parameters can be a integer, float, or boolean type.

image

The Write Tag button will be enabled if all parameters are valid and a tag is detected on a compatible reader. You can also use the Set Value button to test your parameters without overwriting a tag or without a tag present. Be aware that placing a tag on the scanner will load its values into the UI so make sure you place the tag down before you start making your edits otherwise they may be lost.

Technical Bits

Libraries

Summoner's UI is built on Windows App SDK + WinUI 3 with .NET 6. The app talks to your NFC reader using pcsc-sharp and to VRChat via VRCOscLib. Data is serialized using MessagePack.

Data Format

Data is stored on the tags in 4-byte blocks using the following arrangement:

Block Usage
4 Identifying Signature
5 Content Size Header
6.. Serialized Content

Utility Parameters

Summoner sets a couple of parameters in addition to what you specify in the UI that you can use to drive animations.

Gv/Summoner/Triggered: Switches to true for 100ms anytime Summoner sets a value. Gv/Summoner/Present: Set to true while an NFC tag is detected on your reader.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages