Amheklerior / unity-core-library

A library of unity core components and scripts that can be reused across multiple unity projects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Unity Core Library

The Unity Core Library is a unity package that defines core components and scripts that can be reused across multiple unity projects.
This library is designed with two simple principles in mind:

  • Easy to use: The vast majority of components are thought to be easily created and used via the Unity Editor, therefore no programming background is required to use it (provided familiarity with the engine), encouraging team collaboration and fast prototyping.
  • Extensible: Each project has its own specific needs, therefore the concept of a single library to solve them all is, well, a good fantasy incipit. Feel free to extend the classes and the components defined to meet your specific needs.

Table of Contents

Features

Getting Started

To be ready to use this tools, you simply have to install the package in your Unity project. You can import the package either using the Unity Package Manager (UPM) or manually.

Import the Package Using the UPM

To import the package via the Unity Package Manager using the Git URL, you can simply follow the instructions described in the Installing from a Git URL Unity manual page.

Manually Import the Package

To manually install the package, follow these steps:

  1. Download the repository and put the files in a folder named com.amheklerior.core-library in your Packages folder

  2. Edit your manifest.json file in your Packages folder and add the following line as a dependency:

     "com.amheklerior.core-library": "file:com.amheklerior.core-library" 
    
  3. Follow the workflow described in the Assembly Definitions Unity manual page, and add a reference to com.amheklerior.core-library.runtime.asmdef

Requirements

This package has been developed using Unity.2019.3.10f1 and, although it has not been designed for any specific version of Unity, some tools might REQUIRE features from this version of Unity.

Therefore, although there are no specific requirements, it is suggested to use the Unity.2019 or higher version of the engine.

Development & Roadmap

WIP

Support

If you need support, find any issue you'd like to report, or have any suggestions for improvement, please visit the Issue-Tracker

Licence

This package is licenced under the MIT Licence

About

A library of unity core components and scripts that can be reused across multiple unity projects.

License:MIT License


Languages

Language:C# 100.0%