Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3d-group/unity-simple-notifications
Simple UI notifications package for Unity game engine
https://github.com/3d-group/unity-simple-notifications
hacktoberfest npm unity unity3d upm-package utilities
Last synced: 29 days ago
JSON representation
Simple UI notifications package for Unity game engine
- Host: GitHub
- URL: https://github.com/3d-group/unity-simple-notifications
- Owner: 3d-group
- License: mit
- Created: 2020-09-12T05:47:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T04:07:40.000Z (9 months ago)
- Last Synced: 2024-09-28T23:54:25.104Z (about 1 month ago)
- Topics: hacktoberfest, npm, unity, unity3d, upm-package, utilities
- Language: C#
- Homepage:
- Size: 5.31 MB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/com.3d-group.unity-simple-notifications)
[](https://openupm.com/packages/com.3d-group.unity-simple-notifications/)
[](https://opensource.org/licenses/MIT)
# Unity simple notifications
Simple but powerful UI notifications package for Unity game engine.
- [How to use](#how-to-use)
- [Install](#install)
- [via npm](#via-npm)
- [via OpenUPM](#via-openupm)
- [via Git URL](#via-git-url)
- [Tests](#tests)
- [Performance and thread safety](#performance-and-thread-safety-rocket)
- [Configuration](#configuration)
## How to use
1. Right click scene hierarchy
2. Click UI/Notifications
Now you can send Notifications from your script like this:
```c#
Notifications.Send("Hello world");
```
Specify type (changes notification color) and click events with optional parameters:
```c#
private void Error()
{
Notifications.Send("Spooky error!", NotificationType.Error, OnClick);
}
public void OnClick()
{
// Do something.
}
```
There is also async overload:
```c#
await Notifications.SendAsync("Warning!", NotificationType.Warning);
```
You can also hook Translation / any fuction to handle messages before sending like so:
```c#
private void Start()
{
Notifications.TranslationFunction = Translate;
}
private string Translate(string key)
{
// Do something.
return key;
}
```
## Install
### via npm
Open `Packages/manifest.json` with your favorite text editor. Add a [scoped registry](https://docs.unity3d.com/Manual/upm-scoped.html) and following line to dependencies block:
```json
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"com.3d-group"
]
}
],
"dependencies": {
"com.3d-group.unity-simple-notifications": "1.0.0"
}
}
```
Package should now appear in package manager.
### via OpenUPM
The package is also available on the [openupm registry](https://openupm.com/packages/com.3d-group.unity-simple-notifications). You can install it eg. via [openupm-cli](https://github.com/openupm/openupm-cli).
```
openupm add com.3d-group.unity-simple-notifications
```
### via Git URL
Open `Packages/manifest.json` with your favorite text editor. Add following line to the dependencies block:
```json
{
"dependencies": {
"com.3d-group.unity-simple-notifications": "https://github.com/3d-group/unity-simple-notifications.git"
}
}
```
### Tests
The package can optionally be set as *testable*.
In practice this means that tests in the package will be visible in the [Unity Test Runner](https://docs.unity3d.com/2017.4/Documentation/Manual/testing-editortestsrunner.html).
Open `Packages/manifest.json` with your favorite text editor. Add following line **after** the dependencies block:
```json
{
"dependencies": {
},
"testables": [ "com.3d-group.unity-simple-notifications" ]
}
```
## Performance and thread safety :rocket:
- Notifications are rate limited based on duplicates sent recently and max notifications queue length
- Notifications can be send from another thread. Creating GameObjects still always happens on main thread
Here is how it looks when billion notifications are sent simultaneously from another thread: :smile:
Try it yourself! Code:
```c#
using UnityEngine;
using System.Threading;
using Group3d.Notifications;
public class TEST : MonoBehaviour
{
private void Start()
{
new Thread(() =>
{
Thread.CurrentThread.IsBackground = true;
var r = new System.Random();
int counter = 0;
while (counter < 1000000000)
{
Notifications.Send($"Test {r.Next(0, 10000)}");
counter++;
}
}).Start();
}
}
```
## Configuration
Confurable from the inspector:
Custom notification prefab can be created and assigned in the inspector. If doing so, consider these things:
- Prefab must have NotificationUI component (included in the package)
- Prefab must have RectTransform component with anchors set to top-stretch
If prefab is null, notification will be created dynamically.
Optional Font parameter is only used when notification is created dynamically - if that is the only thing you want to change.