/TripleA-Utils

Essential Custom Utilities I use for my Unity Projects (Documentation and Release Coming Soon)

Primary LanguageC#MIT LicenseMIT

Triple A Studios - Utils

A custom unity package that contains utilities for unity projects ranging from Extension Methods to Timer, etc.

Installation

Method 1 (Recommended):

Using Git Url:

  1. Copy the git URL.
  2. Open the package manager window in your unity project.
  3. Click on the little "+" icon in the top left corner and from the dropdown, select "Add package from git URL".
  4. Paste the URL, click "Add" button.

Method 2:

By Unity Package:

  1. Download the .unitypackage file from the Release Page or from the itch page.
  2. Import the package into your unity project.

Method 3 (Not Recommended):

Cloning the git repository directly(gives access unreleased features and access to the branches in development)

  1. Copy the git URL.
  2. Clone the repository directly into your project.

API Reference Documentation

Documentation website coming soon. Meanwhile, summary for each of the method is provided.

Change Log

View Changelog here.

Issues

No known issues as of 20 Aug 2024.

Future updates

Upcoming updates (as of 20 Aug 2024):

  • Create a Subsystem in player loop to manage data binding to the timers to reduce unnecessary overhead created by actions to update time ticks.

Contributing guidelines:

If you wish to contribute to the project, please follow the general contribution guidelines as outlined below:

  • Fork the repository and create a branch from the main branch
  • Make your contributions and commit your changes to your branch
  • Submit a pull request detailing the changes made
  • Wait for your changes to be reviewed and merged

License information

This project is licensed under the MIT license, which can be found on the GitHub repository. The MIT license allows for the use, modification, and distribution of the code for both commercial and non-commercial purposes.

Contact information

For any bug reports, issues, or help regarding the setup of the project, please feel free to contact me on LinkedIn, Instagram @oily.oli, or mail me at ali.qadir.007@outlook.com. My contact information can be found on my GitHub profile also. Alternatively you can leave comments on my itch page too.