Skip to content

Latest commit

 

History

History
124 lines (81 loc) · 3.94 KB

README.md

File metadata and controls

124 lines (81 loc) · 3.94 KB
Raw

TinaX Framework - Core.

logo

LICENSE 996.icu LICENSE

TinaX is a Unity-based framework, simple , complete and delightful, ready to use.

TinaX provides functionality in the form of "Unity packages".

TinaX.Core is core package for TinaX.

  • Core of Framework
  • IoC Container
  • Event System
  • TimeMachine
  • Common method extensions

package name: io.nekonya.tinax.core


"Readme" in other languages :


Install this package

Install via openupm

# Install openupm-cli if not installed.
npm install -g openupm-cli
# OR yarn global add openupm-cli

#run install in your project root folder
openupm add io.nekonya.tinax.core

Install via npm (UPM)

Modify Packages/manifest.json file in your project, and add the following code before "dependencies" node of this file:

"scopedRegistries": [
    {
        "name": "TinaX",
        "url": "https://registry.npmjs.org",
        "scopes": [
            "io.nekonya"
        ]
    },
    {
        "name": "package.openupm.com",
        "url": "https://package.openupm.com",
        "scopes": [
            "com.cysharp.unitask",
            "com.neuecc.unirx"
        ]
    }
],

If after doing the above, you still cannot find the relevant Packages for TinaX in the "Unity Package Manager" window, You can also try refreshing, restarting the editor, or manually adding the following configuration to "dependencies" node.

"io.nekonya.tinax.core" : "6.6.3"

Install via git UPM:

You can use the following to install and use this package in UPM GUI.

git://github.com/yomunsam/TinaX.Core.git

If you want to set a target version, you can use release tag like #6.6.3. for detail you can see this page: https://github.com/yomunsam/TinaX.Core/releases



Dependencies

  • com.neuecc.unirx :https://github.com/neuecc/UniRx.git?path=Assets/Plugins/UniRx/Scripts
  • com.cysharp.unitask :https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask

if you install packages by git UPM， You need to install the dependencies manually. Or dependencies will installed automatically by NPM / OpenUPM



Learn TinaX

You can find out how to use the various features of TinaX in the documentation

Third-Party

The following excellent third-party libraries are used in this project:

  • CatLib : lightweight dependency injection container
  • UniRx : Reactive Extensions for Unity
  • UniTask : Provides an efficient async/await integration to Unity.
  • SharpZipLib : a Zip, GZip, Tar and BZip2 library written entirely in C# for the .NET platform.
  • unity-toolbar-extender : Extend the Unity Toolbar with your own Editor UI code.