Skip to content

An experimental version of YARG with VR support

License

Notifications You must be signed in to change notification settings

Nathan31973/YARG-VR

 
 

Repository files navigation

YARG Gameplay

YARG (a.k.a. Yet Another Rhythm Game)

Twitter Discord Discord


YARG (a.k.a. Yet Another Rhythm Game) is a free, open-source, plastic guitar game that is still in development. It supports guitar (five fret), drums (plastic or e-kit), vocals, pro-guitar, and more! YARG is still in active development, so there may be bugs and missing features.

👉 Disclaimer

Important

YARG stands firmly against all forms of piracy. We neither support nor endorse piracy, as it is a violation of copyright law with serious legal consequences. Our platform's importable content—designed for creators to share their work and for educational purposes—does not justify or excuse piracy.

YARG itself does not use any ripped/pirated assets or music and never will. By using YARG, users agree not to promote or endorse piracy in any way through our platform. Upholding these principles ensures a community that respects copyright, creativity, and legal standards.

YARG stands for "Yet Another Rhythm Game" and NOT for pirates.

📃 Table of Contents

🥽 VR Support

Todo

  • Add openXR and XR interaction tool kit
  • Convert all UI into world space
  • Venue support - limited until venues can have a custom VR spawn point
  • Toggle 2D/VR switcher
  • Grab controller to track guitar (support vive tracker as well)
  • Visual guitar input on guitar model (Kinda there it a hack method)
  • Custom guitar, drum and mic models (Only show guitars atm)
  • Use hands to play guitar (see if this can work on hand tracking devices)
  • rumble support
  • Uses vr drums (virtual drum in the game environment.)

🛡️ License

YARG is licensed under the GNU Lesser General Public License v3.0 (or later) - see the LICENSE file for details.

🧰 External Licenses

Some libraries/assets are packaged with the source code have licenses that must be included.

Library License
NuGet for Unity MIT
Unity Standalone File Browser MIT
Discord GameSDK Licenseless
Lucide ISC
Unbounded, Barlow, and Red Hat Display Open Font License
PolyHaven CC0
BASS Proprietary (free for non-commercial use)

Please note that other libraries are not directly packaged within the source code, and are to be installed by NuGet, Unity's packaged manager, or via a Git submodule.

📦 External Assets and Libraries

These are assets that are installed by NuGet, Unity's packaged manager, or via a Git submodule. These have varying licenses, but can all be downloaded/accessed by the links given.

Link Type Use
YARG.Core Library Provides most of YARG's backend (engine, replays, etc.)
PlasticBand Reference Controller Support Info
GuitarGame_ChartFormats Reference File Format Documentation
PlasticBand-Unity Library GH/RB Controller Support
HIDrogen Library Linux HID Controller Support
EasySharpIni Library Parsing song.ini Files
DryWetMidi Library Parsing .mid Files
Minis Library MIDI Input for Unity
DOTween Library Animation Utility
UniTask Library Async Library
unity-toolbar-extender Library Unity Editor Utility
SoftMaskForUGUI Library UI Utility
Unity-Dependencies-Hunter Library Unity Editor Utility
tmpro-dynamic-data-cleaner Library Prevent Git Change Spam

💸 Donate

Some people have expressed interest in donating. This is an open-source project and therefore donating is not required. If you do want to still help out, spread the word or contribute!

About

An experimental version of YARG with VR support

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 91.9%
  • ShaderLab 7.1%
  • Other 1.0%