https://github.com/umodules/uservice
A lightweight service locator utility for Unity to register, manage, and retrieve services, including MonoBehaviour.
https://github.com/umodules/uservice
dependency-injection monobehaviour service-locator unity
Last synced: about 2 months ago
JSON representation
A lightweight service locator utility for Unity to register, manage, and retrieve services, including MonoBehaviour.
- Host: GitHub
- URL: https://github.com/umodules/uservice
- Owner: UModules
- License: mit
- Created: 2024-10-23T17:35:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T18:50:15.000Z (over 1 year ago)
- Last Synced: 2025-02-14T12:36:22.904Z (over 1 year ago)
- Topics: dependency-injection, monobehaviour, service-locator, unity
- Language: C#
- Homepage: https://useffarahmand.com/
- Size: 12.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UService 🚀
UService is a lightweight service locator utility for Unity, designed to manage and retrieve service instances efficiently. The tool allows for the easy registration, retrieval, and management of services, including `MonoBehaviour` services which must be attached to `GameObject`.
## Features ✨
* 🔧 **Service Registration:** Register services either by providing an instance or through lazy instantiation.
* 🎮 **MonoBehaviour Management:** Handles `MonoBehaviour` services by attaching them to Unity `GameObjects`.
* 🔍 **Service Retrieval:** Retrieve registered services with lazy instantiation.
* 🧹 **Unregister Services:** Clean up services when they are no longer needed.
## Installation 📦
* Clone or download the repository.
* Add the `ServiceLocator` script to your Unity project.
* Make sure the namespace `UService` is referenced in your code.
## Usage 🚀
### Registering a Service 🛠️
To register an existing instance of a service:
```C#
ServiceLocator.RegisterService(myServiceInstance);
```
For lazy instantiation:
```C#
ServiceLocator.RegisterService();
```
### Retrieving a Service 🔍
```C#
var myService = ServiceLocator.GetService();
```
### Unregistering a Service 🧹
```C#
ServiceLocator.UnregisterService();
```
## Example 💡
Here is a simple usage example:
```C#
// Register a new service
ServiceLocator.RegisterService();
// Retrieve the registered service
MyService service = ServiceLocator.GetService();
// Unregister the service when it's no longer needed
ServiceLocator.UnregisterService();
```
## License 📄
This project is licensed under the MIT License. See the [LICENSE](https://github.com/UModules/UService/blob/main/LICENSE) file for details.
## Contributing 🤝
Contributions are welcome! Please submit a pull request or open an issue for discussion.