Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limelight-mint/llm-serialization
[Unity] [Extension] Extension for all the services in your app/game and basic initialization thru ScriptableObject links, no need to have a mess with 9999 serialized fields, use just one and share the date across .NET or Unity Objects
https://github.com/limelight-mint/llm-serialization
extension llm-modules modules plugin unity unity3d unity3d-plugin utility
Last synced: 4 days ago
JSON representation
[Unity] [Extension] Extension for all the services in your app/game and basic initialization thru ScriptableObject links, no need to have a mess with 9999 serialized fields, use just one and share the date across .NET or Unity Objects
- Host: GitHub
- URL: https://github.com/limelight-mint/llm-serialization
- Owner: limelight-mint
- Created: 2024-08-01T01:01:03.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T13:25:55.000Z (2 months ago)
- Last Synced: 2024-10-11T09:44:08.006Z (27 days ago)
- Topics: extension, llm-modules, modules, plugin, unity, unity3d, unity3d-plugin, utility
- Language: C#
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LLM-Serialization
Extension for all the services in your app/game and basic initialization thru ScriptableObject links, no need to have a mess with 9999 serialized fields, use just one and share the date across .NET or Unity Objects!
### Ok but how to actually use it?
> Required UniTask itself, so first-thing-first install a .unitypackage from this link.
> Can be used for default .NET classes if you install UniTask as NuGet package. Also feel free to change whatever you want or collab.
- StaticServices (Global Services)
- DynamicServices (Local Services)
- Injections service-to-service(aka arrays from aliexpress)
First one get initialized on `Link` creation (e.g database). Second one is a flexible and can be added and removed whenever you want at any point of `Link` or `Collectionist` lifespan. Usually you dont need `DynamicServices` if its not a huge project.
(unless you are a resource handling maniac who needs to free resources 24/7 or your service is a miner)
# Static Services
> There is a CollectionistLink for serialization purposes if you want to get services in `MonoBehaviour` objects
> Drag and drop it to any `[SerializedField] private CollectionistLink _link;` field and initialize it (usually on startup of your app)
> Register service you wanna use in this collectionist (`_link.Service` to get actual service from the link whenever you want)
```
public class Initializer : MonoBehaviour
{
[SerializeField] private CollectionistLink _link;
private void Awake()
{
ServiceCollection globalServices = new ServiceCollection()
.Add(new SaveService())
.Add(new SettingsService())
.Add(new AudioService())
.Add(new LocalizationService())
.Add(new PopupService(popupRoot))
;
_link.Create(globalServices).Initialize();
}
}
```
> [!TIP]
> `_link.Initialize()` is an awaitable operation in case your services do something on startup (like GET request from database, or load Audio). If so, put `await` before creation. (like so: `await _link.Create(globalServices).Initialize();`)
> Now you can use it whenever you want by getting that `ServiceCollection` like `_link.Service` to get actual service from the collection:
```
[SerializeField] private CollectionistLink _globalCollection;
...
Collectionist collection = _globalCollection.Service;
collection.Get(out var audioService, out var popupService);
audioService.PlayMusic("HOYOMiX - Shade of Flowers");
popupService.ShowPopup();
...
```
# Dynamic Services
Basically, they are the same but without creation process.
> Add services whenever you want:
```
[SerializeField] private CollectionistLink _globalCollection;
...
_globalCollection.Service
.Add(new HoyoClientWrapper())
.Add(new HoyoFpsUnlocker())
.Build();
...
```
> [!TIP]
> `Collectionist.Build()` is an awaitable operation in case your services do something on startup (like GET request from database, or load Audio). If so, put `await` before creation.
> Using them in same pattern, just use `_globalCollection.Service.Get()`:
```
_globalCollection.Service.Get().UnlockFps();
```
> Or if you need service multiple services:
```
_globalCollection.Service.Get(out var fpsUnlock, out var wrapper);
```
> [!WARNING]
> Dont forget to `_link.Service.Remove(service)` or `_link.Service.Remove()` if you dont need it anymore or if service was destroyed!
### Injections
TODO: Change array injections to the more proper way (class or auto-inject reflection)
> [!CAUTION]
> If you gonna use Injections (if you need some services to be inside other services, for example our SaveService neeeded LoginService to get GET request from server with all user inventory), then you NEED to .Add(service) SERVICES IN ORDER! so the first services initialized first, and those who depends on them are the last one. Here is example of service used injection:
> [!NOTE]
> You can use/create new links for any service if you want, but thats not that efficient since collectionist already contains everything inside. But we are not stopping u...
```
[CreateAssetMenu(fileName = "CollectionistLink", menuName = "Services/Links/CollectionistLink", order = 1)]
public class CollectionistLink : ScriptableObject, ISerializedService
{
///
/// use Service = new Collectionist(new ServiceCollection().Add(services)); or Create(services) before init
///
public Collectionist Service { get; private set; }
public void Create(ServiceCollection servicesList)
{
Service = new Collectionist(servicesList);
}
public async void Initialize() => await Service.Initialize();
}
```