An open API service indexing awesome lists of open source software.

https://github.com/bastianblokland/typedtree-generator-unity

Unity package for generating 'treescheme' files based on dotnet assemblies.
https://github.com/bastianblokland/typedtree-generator-unity

behaviour-tree descision-tree json-tree tree-editor unity upm

Last synced: 6 months ago
JSON representation

Unity package for generating 'treescheme' files based on dotnet assemblies.

Awesome Lists containing this project

README

          

# TypedTree-Generator-Unity

Unity package tool for generating treescheme files for use in the [**TypedTree-editor**](https://github.com/bastianblokland/typedtree-editor)

## Description
To avoid having to handwrite treescheme files you can generate them based on the c# class
structure of your tree (for example a behaviour tree structure).

The scheme files produced can be used to edit tree's in a visual way using the [**website**](https://www.bastian.tech/tree).

## Installation
1. Add a reference to this repository to your package dependencies (`Packages/manifest.json`)

```
"dependencies": {
"com.typedtree.generator": "https://github.com/BastianBlokland/typedtree-generator-unity.git#v1.2.1",
...
}
```
2. Add the NuGet dependency to your project.

If your project uses a NuGet package manager you can simply add a dependency to [**TypedTree.Generator.Core**](https://www.nuget.org/packages/TypedTree.Generator.Core/).

If you are not using a NuGet package manager you can simply copy the dll's from the [`.lib`](https://github.com/BastianBlokland/typedtree-generator-unity/tree/master/.lib) directory to your project.

## Usage
1. Create a `Generator` scriptable-object. (Right mouse the project window -> `Create/TypedTree/Generator`)
2. In the `Root Alias Type` field of the generator configure what type (`interface`, `class`, or `struct`) to use as the base of your tree.
3. In the `Field Source` field of the generator configure where the generator should look for fields on nodes.
4. In the `Output Path` field of the generator configure where to output the scheme json. (Relative to the `Assets` directory)

## Example
An example of how to integrate this package with unity project can be found in the [`.example`](https://github.com/BastianBlokland/typedtree-generator-unity/tree/master/.example) directory.

## Help
More information about the generator library: [**typedtree-generator-dotnet**](https://github.com/BastianBlokland/typedtree-generator-dotnet)

More information about the editor: [**typedtree-editor**](https://github.com/BastianBlokland/typedtree-editor)