Skip to content

Limitex/mono-ui

Repository files navigation

Logo

Mono UI

Mono UI is a UI component package for VRChat world creation. It provides simple and customizable UI elements optimized for VRChat environments, helping creators build interactive and user-friendly interfaces in their worlds.

🌟 Features

  • Add UI prefabs easily from GameObject Context Menu
  • Change themes instantly in the editor with Color Manager
  • Includes sample prefabs for quick setup and testing
  • Add icons effortlessly with Lucide React integration
  • Easy installation via VCC (VRChat Creator Companion)
  • Lightweight and optimized for performance
  • Comprehensive documentation available at docs.limitex.dev
  • Tested with Unity 2022.3.22f1 and VRChat SDK 3.7.0
  • Modular components for custom UI creation

🚀 Get Started

1. Install Mono UI

  1. Open VRChat Creator Companion
  2. Add Mono UI as a VCC Repository
  3. Select your VRChat world project and install Mono UI

2. Import Text Mesh Pro

After installing Mono UI:

  1. Open Unity Editor
  2. Go to Window > TextMeshPro > Import TMP Essential Resources

🎁 Samples

The package includes ready-to-use sample scenes and prefabs:

  • UI Sample: A comprehensive showcase of all UI components and their variations
  • Platform Statistics: Real-time platform usage statistics display
  • World Log: World event logging system
  • Quiz Menu: Interactive quiz system with object enable/disable
  • Simple Mirror: Basic mirror setup for VRChat worlds

To use the samples:

  1. Navigate to GameObject > Mono UI > Sample
  2. Select the desired sample prefab

📖 Documentation

For detailed documentation, visit: https://docs.limitex.dev/vrc/monoui

📞 Support

For bug reports and feature requests, please use GitHub Issues.

✨ Contributors

Limitex
Limitex

Docs | GitHub

🎉 Special Thanks

This project is inspired by and may use components from:

Lucide
Lucide

Docs | GitHub
shadcn
Shadcn ui

Docs | GitHub

📝 License

Copyright (c) 2024 Limitex - MIT License

About

Mono UI is a UI component package for VRChat world creation. It provides simple and customizable UI elements optimized for VRChat environments, helping creators build interactive and user-friendly interfaces in their worlds.

Topics

Resources

License

Stars

Watchers

Forks

Contributors