https://github.com/halomakes/gravyvrc.summoner
https://github.com/halomakes/gravyvrc.summoner
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/halomakes/gravyvrc.summoner
- Owner: halomakes
- License: gpl-3.0
- Created: 2023-05-31T00:59:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T22:01:43.000Z (about 3 years ago)
- Last Synced: 2025-01-22T05:31:49.985Z (over 1 year ago)
- Language: C#
- Size: 12.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GravyVRC Summoner
Control your VRChat avatar with NFC tags!
[](https://www.microsoft.com/store/productId/9PBSBFXXP0DF)
## Hardware
Summoner was developed against this hardware. I cannot guaruntee compatibility with other scanners/tags.
- [ACR122U](https://www.acs.com.hk/en/products/3/acr122u-usb-nfc-reader/)
- [NTAG213](https://www.nxp.com/products/rfid-nfc/nfc-hf/ntag-for-tags-and-labels/ntag-213-215-216-nfc-forum-type-2-tag-compliant-ic-with-144-504-888-bytes-user-memory:NTAG213_215_216)
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](https://github.com/halomademeapc/GravyVrc.Summoner/issues/17).
[](https://apps.microsoft.com/store/detail/9PBSBFXXP0DF?launch=true&mode=mini)
### Manual Installation
You can also head to the [releases](https://github.com/halomademeapc/GravyVrc.Summoner/releases) page and download non-packaged builds for your platform from there.
## Usage
Click **Add Parameter** to add parameters to set on your avatar anytime the tag is scanned while the app is open.
Parameters can be a integer, float, or boolean type.
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](https://github.com/danm-de/pcsc-sharp) and to VRChat via [VRCOscLib](https://github.com/ChanyaVRC/VRCOscLib). Data is serialized using [MessagePack](https://github.com/neuecc/MessagePack-CSharp).
### 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.