Custom VRC World Web UI Assets (Udon)

This pack has several very useful prefabs that any world/game builder might find extremely handy. This pack relies on new (as of April 2023 updates) VRChat functionality that allows game worlds to reach out to the internet and pull in text and image data, and use that data within the world. This allows a world builder to be able to update text and images within their world without having to update and re-upload their world project to VRChat. So, if a list of supporters are updated, all the world builder (or moderator) need do is update a text file on a web site, and that data is automatically used in the world.

For more information and limitations on the VRChat web download functionality, please visit:

• For Text : https://docs.vrchat.com/docs/string-loading
• For Images : https://docs.vrchat.com/docs/image-loading

This pack contains several prefabs that do a variety of functions.

• Generic Text File Reader :
  • This prefab reads a text file and displays it in a UI panel. If the text is longer than the height of the panel, the text will scroll at a readable speed (which can be set by the world builder).
• Generic Image File Reader :
  • This prefab reads image files from the web. If one image is set, that image will always be displayed. If more than one image are set in the prefab, the prefab will cycle through each image, in the order they are listed. The world builder can set the transition time that one image fades into the next, as well as the duration the image is displayed before moving on to the next image. When the last image is reached, the loop starts at the beginning and continues infinitely.
• Change Log Reader :
  • This prefab is almost exactly like the Generic Text File Reader, but is more suited for Change Logs for changes made in your world.
• Supporter List Reader :
  • This prefab reads a list of players (and their numeric ranks) and displays them in the order listed. There are pre-configured ranks, which you can change in the code by editing the UDONsupporterList UdonSharp script file, to suit your world's specific needs. The supporters will have their rank listed alongside their color-coded name. Additionally, any supporters that are currently in a world instance will be displayed in a separate list specifically for "Supporters that are here Now".
• Banned User List :
  • This prefab reads a list of players that are banned in this world. When a player joins the world, their player information is check against the list. Any player on the ban list will be automatically teleported to a far off area of the world and kept there, out of reach. Additionally, players using the respawn functionality will simply be put "back in jail".
• World Poster :
  • This prefab is designed as an all-in-one stop for information about the world. You can display the world/game title, the current version, the author(s) name(s), the local time, Game Rules, Hints & Tips, Credits List of the third party assets used, as well as an instance of the Change Log prefab and the Supporters List prefab. The scripts used in this package (C#/UdonSharp) are well organized and well documented. Feel free to make modifications (particularly to the UDONsupporterLog file, for Patron Ranks). The UI is highly modifiable, so that you can change it to fit your world.
• Portals :
  • This prefab contains several VRC World Portal game objects, and reads a text file to populate those portals with links to other player worlds. You can update the portals in your world simply by updating the world ids listed in the text file.

CONFIGURATION, USAGE & LIMITATIONS

You should be using the VRChat Creator Companion tool, as it provides the latest version of UDON and UDONsharp, which are necessary for these scripts to run. You will automatically be asked to install the Unity-provided TextMeshPro component. Please do this, as all the UI elements use TextMeshPro elements for all displayed text. The prefabs are all pre-configured and should work simply by dragging and dropping them into your world scene, then linking them to your provided text. Some prefabs may need additional configuration changes to meet the needs of your game/world. The Banned User List has a room attached to it where banned users are sent when they log in/respawn. There should be no configuration changes needed. Drag and drop, and place this prefab as the others and everything should work fine.

A brief note on networking, network lag and network desync. At times, beyond our control, network lag can cause different "realities" between players in a game world. Additionally, VRChat places time constraints to the use of the download from web feature. At the time of this writing, there is a 5 second delay between downloading each text file or image file. So, if you have five (5) separate prefabs making calls to 5 text files, it will take a total of 25 seconds before all text files are displayed. Same for the Image Reader prefab; multiple Image Reader prefabs will mean more time to load all images. However, for the Image Read prefab, images are loaded the first time they are called, and stored for future use when the prefab loops through them. This saves time and network calls.

Want to see these assets in a live environment? We have a world published for you to check out! Click here to give it a sniff.

What you will need:

• Unity 2019.4.31f1 or higher
• VRChat Creator Companion with the latest update installed
  • Scripting used in this package utilizes Udon#
• A basic understanding of how a UI element in Unity works (if you want to customize it)

Who we are:

We are two 3D content producers specializing in unique models, avatar accessories, VR worlds and experiences, and beautifully done, well written and documented code. Ms Malvolio does the 3D modeling work and texturing. Corina does the programming. We have released VR Chat game worlds, avatar prefabs, furniture packs, small models, and some small artwork. Our goal is to make others enjoy working in Unity as much as we do, and have something cool to show for it!

Join us on Discord!