Skip to content

README.md

Latest commit

 

History

History
96 lines (68 loc) · 4.19 KB

README.md

File metadata and controls

96 lines (68 loc) · 4.19 KB

ARM-Icon Addressable Resources Management

GitHub Release Static Badge Static Badge

Static Badge Static Badge Static Badge

ARM-MainTitle

📌 Introduction

ARM(Addressable Resources Management) is an extension utility for Unity's Addressables package.

It's a system that wraps the handle management elements, which are a drawback of the existing addressables, to automate management as much as possible.

It also simplifies resource loading, caching, and memory management to provide performance and convenience for game development.

📌 Table of contents

Install via Git

  • For Unity 2019.3 and above, you can install via Git URL using the Package Manager

    1. Open Window -> Package Manager in Unity Editor
    2. Click the + button in the top left and select Add package from git URL...
    3. Enter the URL below and click the Add button
https://https://github.com/HuiSungz/Unity-AddressableResourcesSystem.git

Install via OpenUPM

  • This package is available on OpenUPM package registry.
  • This is the preferred method of installation, as you can easily receive updates as they're released.
  • If you have OpenUPM-CLI installed, then run the command
openupm add com.hs-architect.addressable-resources-system

Dependencies

  • The ARM framework has dependencies on the following packages:
    • Unity Addressables : 2.3.16
    • UniTask : Latest

The package automatically detects and installs the necessary dependencies during installation.
If installation fails, reinstall or reimport the package.
When installation is completed successfully,
the symbol ARM_UNITASK will be added and you can access the classes.

📝 Documentation

  • Standardized documentation and usage instructions can be easily found through the Wiki page.
  • Click on the image to go to the document.

ARM-WikiDocs

Key Features

  • Asynchronous Loading System: Fast and efficient asynchronous loading based on UniTask
  • Automatic Caching Mechanism: Prevents duplicate loading of assets that have been cached at least once
  • Memory Management: Reference counting-based memory management system through AssetEntry
    • Users only need to return unused entries through mirroring in destructors or events
  • Reference Tracking: Debugging tool for real-time monitoring of asset usage
  • Type Safety: Provides type-safe APIs based on generics

Contact

If you find a bug or have a feature request, please open an issue on GitHub.
For general questions or if you need help, please contact via email.

License

This library is under the MIT License.