'
Report Bug or Request Feature

About The Project

Documentation

Framework that contains useful Modules to be Used in Unity Project.

Built With

• V2021.3.5f1

Installation

To install this into your project for modifications Clone or Download the code from Git Hub into your project. Check Out Third Party Notices for additional assets that where used in this project that you can get from the asset store.

Roadmap

See the open issues for a list of proposed features (and known issues).

Currently in Work: Documentation, Samples, Attributes using UI Elements, and Scriptable Object Variables and Game Events.

• Scriptable Object Variables and Game Events
• Documentation:
  • Manual
    • Animation
      • Animation Parameters
        • Bool
        • Float
        • Int
        • Trigger
      • Animation Parameter Drawer
    • Attributes
    • Create From Game Object
    • Destroy
      • After Time
      • No Children
    • Extensions
      • Array
      • Quaternion
      • Text
      • Vector4
    • Functional
      • Option
    • Interactable
    • Scriptable Object Variables and Game Events
  • API Documentation
• Samples
  • Animation
    • Animation Parameters
      • Bool
      • Float
      • Int
      • Trigger
    • Animation Parameter Drawer
  • Attributes
  • Destroy
    • After Time
    • No Children
  • Extensions
    • Array
    • Quaternion
    • Text
    • Vector4
  • Functional
    • Option
  • Interactable
  • Scriptable Object Variables and Game Events
• Attributes using UI Elements
  • Header
    • Add Header Element to Property Element
    • Use Style Sheet
  • Info Box
    • Add Header Element to Property Element
    • Use Style Sheet
  • Icon
  • Show If Bool
  • Show If Enum

License

Distributed under the MIT License. See for more information.

License

• 
• Ryan Hipple's Game Architecture with Scriptable Objects from Unite Austin 2017
  • Ryan Hipple's Game Architecture with Scriptable Objects from Unite Austin 2017
  • @roboryantron
  • The slides are on slide share.
  • [!Video https://www.youtube.com/embed/raQ3iHhE_Kk]
  • The video for the talk is posted on Unity's YouTube page.
  • 

Add API documentation

Add this to the doc.json file

{
  "metadata": [
    {
      "src": [
        {              
          "src":"../",
          "files": ["**.cs"],
          "exclude": [
            "docs/**",
            "**/bin/**",
            "**/obj/**",
            "Documentation~/**",
            ".git/**"
          ]
        }
      ],
      "dest": "api",
      "disableGitFeatures": false,
      "disableDefaultFilter": false,
      "force": true
    }
  ],
  "build": {
    "content": [
      {
        "files": ["api/**"]
      },
  }
}