https://github.com/pablothedolphin/Scriptable-Framework

A Unity Framework for modular app creation based on ScriptableObject architecture, data oriented design and event driven programming to help programmers and designers adhere to the 5 SOLID programming principals.
https://github.com/pablothedolphin/Scriptable-Framework

dependency-injection framework modularity unity

Last synced: 1 day ago
JSON representation

A Unity Framework for modular app creation based on ScriptableObject architecture, data oriented design and event driven programming to help programmers and designers adhere to the 5 SOLID programming principals.

• Host: GitHub
• URL: https://github.com/pablothedolphin/Scriptable-Framework
• Owner: pablothedolphin
• License: mit
• Created: 2019-08-13T08:01:48.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-20T09:58:32.000Z (over 4 years ago)
• Last Synced: 2024-08-02T05:13:12.668Z (3 months ago)
• Topics: dependency-injection, framework, modularity, unity
• Language: C#
• Homepage: https://pablothedolphin.github.io/Scriptable-Framework/index.html
• Size: 3.33 MB
• Stars: 65
• Watchers: 8
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scriptable Framework

[![openupm](https://img.shields.io/npm/v/com.open.scriptable-framework?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.open.scriptable-framework/)

In this repository you will find the source code, assets and project settings of the Scriptable Framework for Unity app development (Unity 2018.4.4 or newer recommended) along with a DocFX project containing documentation assets and articles.

---

## NOTICE

> The master branch contains our most stable and release with accurate documentation.

> [Documentation can be found here](https://pablothedolphin.github.io/Scriptable-Framework/).

## How To Install

See instructions in [this](https://pablothedolphin.github.io/Scriptable-Framework/articles/howToInstall.html) part of the documentation.

---

## Roadmap

> Roadmap is subject to change. Last reviewed 14th of February 2020.

| Version | Defining Feature                  						  				    |

| ------- | --------------------------------------------------------------------------- |

| ~0.1~   | ~RuntimeLists, Event API and Statemachines~					 			    |

| ~0.2~   | ~Upgrade to Unity 2018.3 for nested and variant prefabs~         			|

| ~0.3~   | ~RuntimeItems added~           	     			  				            |

| ~0.4~   | ~Extend RuntimeItems and Lists with Reference and Value typing~             |

| ~0.5~   | ~Provide icons for the various data and component types~                    |

| ~0.6~   | ~Complete Styling API~                  	     			  		        |

| ~0.7~   | ~Provide full unit test coverage for the core Scriptable Framework APIs~    |

| ~0.8~   | ~Extracted styling API into its own package~							    |

| ~0.9~   | ~Create scripting API documentation via DocFX and host on gitlab pages~     |

| ~0.10~  | ~Add StateMachineController to control many StateMachines at once~          |

| ~1.0~   | ~Deploy on an internal npm registry~									    |

| ~1.1~   | ~Create a menu item to toggle event logging within the editor~		        |

| ~1.2~   | ~Added AppVersion API and string types for ValueList and ValueItem~		    |

| 2.0     | Decouple RuntimeObjects from Resources folder using a RuntimeObjectDatabase |

| 2.1     | Automatic script and dependancy generation wizard                           |

---

## Contacts

For more information contact:

* Jak Hussain - [GitHub](https://github.com/pablothedolphin)

* Dean Giddy - [GitHub](https://github.com/DeanGiddy)

* Conor Galvin - [GitHub](https://github.com/Cvnvr)