Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielfvm/udonnotifier
A VRChat Notification System for your world. Includes built in support for Player Join/Leave notification and outdated instance warning.
https://github.com/danielfvm/udonnotifier
notification prefab udonsharp unity vrchat
Last synced: 27 days ago
JSON representation
A VRChat Notification System for your world. Includes built in support for Player Join/Leave notification and outdated instance warning.
- Host: GitHub
- URL: https://github.com/danielfvm/udonnotifier
- Owner: danielfvm
- License: mit
- Created: 2024-05-26T07:26:15.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-04T16:12:01.000Z (5 months ago)
- Last Synced: 2024-09-26T08:00:13.871Z (about 1 month ago)
- Topics: notification, prefab, udonsharp, unity, vrchat
- Language: C#
- Homepage:
- Size: 4.16 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UdonNotifier v2
A VRChat Notification System for your world. Use this prefab for sending notification messages to players. You can use it for sending error messages, hints, tooltips, visual feedback after interacting with objects or use some of the built in features like:
* Player Join/Leave notification
* Outdated instance warning
* Custom welcome message
Additionally supports:
* Overriding notification sound and display time
* Supports showing multiple notifications at the same time
A preview VRChat world is available [here](https://vrchat.com/home/world/wrld_b0cb0277-4e43-45e5-89be-ba671fa25562).
## Installation
Download the prefab from releases, double click the `.unitypackage` and in Unity click on `Import`. Make sure to also import the required TextMeshPro Assets if you haven't already!
Finally, Drag and Drop the `Assets/UdonNotifier/NotificationManager` Prefab into your Scene.
## Configuration
The `NotificationManager` contains following scripts that can individually be configured:
* NotificationManager
Here you can configure the position, size and default fade in/out sound of the notifications.
Use a reference to the script to send your own custom Notifications.
* Join Leave Notifier
Shows notifications when a player joins or leaves your world. You can change the message format, duration and optionally you can disable seeing your own join/leave notifications. If you don't want join/leave notifications in your world, disable the Component.
* Welcome Notifier
Displays a custom welcome message to players joining your world. You could use it to give players a hint how to access menus, general information, plug your patreon or simply to greet them :). Disable the Component if you don't need this.
* Update Notifier
Will automatically warn the player if they joined an outdated instance of your world. This can be useful if you have many active players in your world and frequently update your world, as things might get broken when players with different versions of your world join the same instance. You can change the message and display duration in the settings. Disable the Component if you don't need this. Additionally it will display a debug log message that shows the version and upload date of both the instance and your local version.
## Custom Messages
Sending a custom notification from UdonSharp is as easy as:
```cs
using DeanCode;
// Reference to the NotificationManager GameObject
[SerializeField] NotificationManager manager;
void Start()
{
// Send a `Hello World!` Notification with a warning symbol for 10 seconds
manager.SendNotification("Hello World!", NotificationType.Warning, 10);
}
```
## Credits
Crediting this prefab is not required, but if you do it is very appreciated <3