Welcome! VizVid is a general-purpose video player frontend for use in VRChat. It aims to cover many use cases, from watch-together video/live stream player in lounges, to large event venue for music performances, or even booths for exhibitions or showcases. Due to its target customers, it has a flexible architecture, just like a factory made electronic but with a easy to open back lid, make it easier to let users mess them around for their needs.
- Basic playback, seeking controls
- Pre-defined playlists & user queue list
- Playback history for user inputed URLs (since v1.0.32)
- Quest (Android) client specific URLs (only available on pre-defined URLs, play lists and API)
- PNG/JPEG Image Viewer (since v1.0.37)
- Low latency mode, (tested with RTSP/RTMP streams)
- Playback speed adjustment (since v1.1.0)
- Smart request handling, debounces switch video requests to avoid rate limit errors (since v1.1.0)
- Local mode (toggleable syncing with other users within instance before uploading)
- Modulized screen, audio & UI architecture, support multiple instances
- Both on-screen & separated interfaces available
- Optional extra alternative URL input for supporting cross-platform users (since v1.3.0)
- (Almost) one-click to change interface colors
- Supports both legacy UI and TextMeshPro setup (since v1.0.32)
- Local pickupable & scaleable screen
- Wrist band (VR) / keyboard (desktop) resync button & volume controls
- Auto plays when local user steps into specific region
- Auto fades out background music when video is playing
- Dedicated component assigns random stream link per-instance/user (since v1.3.0)
- Custom shader with various display modes built-in (Stretch, Contain, Cover, Stereographic Video Source), can be configurated on material options
- Luminance adjustment for screens using built-in materials (sice v1.1.0)
- Localization system with auto language detection (English, Chinese, Japanese & Korean)
- Locked UI with Udon Auth.
- Basic Audio Link support, which will auto switch audio source when playing, also reports player state (playback progress, volume, loop, shuffle, etc.) on newer version (1.0.0+).
- Basic LTCGI integration, provided CustomRenderTexture for use.
- Bundled a modified version of YTTL to display video title from known sources.
- Dedicated updater for VRC Light Volumes.
- Simple API for [your own udons] integration.
- Privacy first - We guarantee we do not include features that requires dedicated server to work; Also, features requires external resources are not opt-in by default.
Please visit the official demo world!
You may use following methods:
- Via VCC (Recommend):
- Ensure you have installed VRChat Creator Companion, if not, download here.
- Go to my package listings landing page, click "Add to VCC" button under the banner and follow instructions.
- You can then go to "Manage Project" of your own world project, click on the "+" button to add the player component.
- Enjoy!
- Via Command Line:
Alternatively, instead of VCC, if you are an advanced geek like to use command line, you may use a tool calledvrc-get:cd path/to/your/world/project/folder vrc-get repo add https://xtlcdn.github.io/vpm/index.json vrc-get install idv.jlchntoz.vvmw
- Via Booth: Click here.
- Via GitHub Releases: Click here.
For any issues, please contact me on Discord server or file an issue on GitHub if you believe there is a bug.
- Vistanz (@JLChnToZ) - Programming
- 山の豚 (@yama_buta) - Art
- LR163 & Cross - Make this Project Happens, Early Tester
- HsiaoTzuOWO - Early Tester
- Yan-K - UI / UX Consultant
- 六森 - Advertisement Materials, Demo World
- 水鳥 Waterbird - Naming, Japanese Documentation Proofreading
- Kuriko - Assisted Documentations, Assisted Japanese / Traditional Chinese Localization, Community Support
- 奈良阪 Narazaka - Assisted Japanese Localization
- Sonic853 - Assisted Simplified Chinese Localization
- Krislyz - Assisted Hebrew Localization
- JustTemTem & Meiji - Assisted Thai Localization
- はるる早苗 HaruruSanae - Assisted Japanese Documentation
- All Other GitHub Contributors
Important
This project is licensed under the MIT License — it is NOT public domain, and it is NOT CC0.
You are very welcome to use, modify, and redistribute this code in your own projects, including commercial ones. However, the MIT License requires that the copyright notice and license text be retained in all copies or substantial portions of the Software.
Please note:
- "Substantial portion" is not limited to large blocks of code. A distinctive function, a non-trivial algorithm, or a creative implementation can qualify — even if it's short.
- Cosmetic changes do not remove the obligation. Renaming variables, reformatting, or mechanically refactoring a copied portion does not make it your own work. If the expression is derived from this project, attribution is required.
- Reimplementing an idea from scratch is fine. Copyright protects expression, not ideas or algorithms. If you read this code, understand the concept, and write your own implementation independently, you owe nothing — though a mention is always appreciated.
To comply, please include at minimum:
- The original copyright notice (
Copyright (c) [year] [author]) - A copy of the MIT License text
- A reasonable indication of the source (e.g., a link to this repository)
Honest users have nothing to worry about — adding a few lines to your LICENSE, NOTICE, or README is all it takes.
Also, since the assets of VizVid have already included this information, you don’t need to add anything further when using it in Unity or VRChat.
However, be aware: the MIT License's permission is conditional on compliance. Copy a substantial portion without attribution, and your use falls outside the license — leaving plain, unlicensed copying under copyright law. No grace period, no prior warning, no revocation needed: the permission simply never extended to that use. All remedies under copyright law are reserved.
Thank you for respecting the work of open-source authors.
本プロジェクトは MIT ライセンスの下で公開されています。パブリックドメインや CC0 ではありません。
本コードを商用・非商用問わず、ご自身のプロジェクトで自由に使用・改変・再配布していただくことは大歓迎です。ただし、MIT ライセンスの規定により、ソフトウェアの全体または実質的な一部（substantial portion）を複製・再配布する際には、著作権表示およびライセンス全文を維持することが義務付けられています。
以下の点にご留意ください：
- 「実質的な一部」とは、大量のコード（行数）だけを指すものではありません。 特徴的な関数、独自のアルゴリズム、創作性のある実装などは、たとえ短くても対象となる場合があります。
- 表面的な改変によって、上記の義務が免除されることはありません。 変数名の変更、コードの整形、機械的なリファクタリングを施したとしても、コピー元の表現に依拠している限り、それは独自の成果物とは言えません。本プロジェクトの表現に由来する部分には、クレジット（帰属表示）が必要です。
- アイデアを理解した上で、一から自力で書き直すのは問題ありません。 著作權が保護するのは「表現」であり、「アイデア」や「アルゴリズム」そのものではありません。本コードを読んで仕組みを理解し、独立してご自身で実装し直されたのであれば、表記の義務は発生しません（ただし、参考として一言言及していただければ幸いです）。
特に、MIT ライセンスを「自由に何でもしてよい」「クレジット不要」と誤解されているケースが散見されますが、それは誤りです。「無償で利用できる」ことと「無断で利用できる」ことは全く異なります。
ライセンスを遵守いただくため、最低限以下の内容を明記（または同梱）してください：
- オリジナルの著作権表示（
Copyright (c) [年] [著作者名]） - MIT ライセンスの全文
- 出典の明示（本リポジトリへのリンク等）
通常のご利用において、過度に心配される必要はありません。LICENSE、NOTICE、README のいずれかに数行追記いただくだけで十分です。
また、VizVid本体では、すでにクレジットの表記が用意されていますので、別途追加で記載していただく必要はございません。
【重要：法的な留意事項】 MIT ライセンスによる利用許諾は、本規定の遵守を条件として成立します。実質的な一部をクレジット表記なしで複製した時点で、その利用はライセンスの許諾範囲外となり、著作権法上の**「無許諾複製（著作権侵害）」**に該当することになります。 この場合、猶予期間の付与や事前的警告、許諾取消の通知といった手続きを経ることなく、その利用には最初から許諾が及んでいなかったものとみなされます。 当方は、著作権法に基づき、必要なあらゆる法的救濟措置を講じる権利を留保します。
オープンソース著作者の成果と労力に敬意を払い、皆様のご理解とご協力をお願い申し上げます。
Made with ❤️ in 🇭🇰 🇹🇼.
