Arys

Version 2.0.1 of UnityToolkit

# UnityToolkit ## What is this library for? This library aims to provide additional tools to client modders which will (hopefully) allow them to write more optimised code and reduce the performance cost and memory allocation of their code even further. ## How to install this library (for users) 1. Download the latest release 2. Open the .7z with 7-Zip 3. Drag and drop the 'BepInEx' folder into your game folder 4. Play SPT ## How to use this library (for mod developers): 1. Download the latest release 2. Copy the assemblies from the release zip to where you store your project's assembly references 3. Add all the assemblies as assembly references to your project 4. Add `[BepInDependency("com.arys.unitytoolkit")]` attribute to your plugin class (I recommend you add a minimum version string to the attribute) 5. You can now use *<span style="color:#0090AA">UniTask</span>*, *<span style="color:#B00090">Unity.Collections</span>*, *<span style="color:#AB1010">VContainer</span>*, *<span style="color:#D0A000">ZLinq</span>* and *<span style="color:#009000">ZString</span>* in your mod ## What features does this library provide? 1. *<span style="color:#0090AA">UniTask</span>* is a near zero-allocating, performant version of C# Tasks that's suited for Unity than the standard C# implementation - It doesn't use threads or `SynchronizationContext`/`ExecutionContext` so the result is faster performance and lower allocation while matching Unity threading (single-thread) - It is also possible to replace Unity's Coroutines, which has poor performance and higher memory allocation, with UniTask instead - Documentation: https://github.com/Cysharp/UniTask 2. *<span style="color:#B00090">Unity.Collections</span>* is included in this library for the additional `NativeContainer` types it provides - `NativeList`, `NativeHashMap`, `NativeMultiHashMap`, and `NativeQueue`: these are useful data types when you are working with Unity's Jobs system as they are thread-safe - Documentation: https://docs.unity3d.com/Packages/[email protected]/manual/collections-overview.html 3. *<span style="color:#AB1010">VContainer</span>* is a fast Dependency Injection container, designed for Unity and works with injecting into both standard C# classes and Unity MonoBehaviours - Documentation: https://vcontainer.hadashikick.jp 4. *<span style="color:#D0A000">ZLinq</span>* provides high performance, zero-allocation LINQ by utilising `ValueEnumerable`, made by the developer of UniTask - Documentation: https://github.com/Cysharp/ZLinq 5. *<span style="color:#009000">ZString</span>* is a near zero-allocating string builder, which is also made by the developer of UniTask and ZLinq - Documentation: https://github.com/Cysharp/ZString ## Also included: - FixPluginTypesSerialization is a patcher that fixes custom classes/structs with the `[System.Serializable]` attribute not being deserialized properly for BepInEx plugins - Thanks to Tarkin for discovering this bug and the fix ## Is it safe? Yes, all assemblies are just compiled versions of their original git repo I've also included a VirusTotal scan of all assemblies on the GitHub releases page ## Building from source 1. Clone the repository: ``` git clone https://github.com/Nympfonic/UnityToolkit.git ``` 2. Place the compiled assemblies for UniTask, Unity.Collections and ZString in `project\UnityToolkit\References`. 3. Adjust the reference paths, macros and build events in the .csproj files 4. Open solution in your preferred C# IDE 5. Build solution

# WARNING There is an issue with **v2.0.0 release** which causes the game to fail to load into the main menu with certain mods installed. **Solution:** Please delete the “FixPluginTypesSerialization” folder inside the “BepInEx/patchers” folder. After following the above solution, you may also update to v2.0.1 Sorry for the inconvenience!