Skip to content
A collection of design patterns for solving common problems.
Branch: master
Clone or download
thestonefox Merge pull request #395 from ExtendRealityLtd/fix/collision-tracking
fix(Collision): perform equality check on collider and forward source
Latest commit 91b8e16 May 19, 2019

README.md

Zinnia logo

Zinnia

A collection of design patterns for solving common problems.

[zin-ee-uh]

License Backlog

Introduction

Zinnia is a collection of design patterns for the Unity software that can be beneficial in (but not limited to) spatial computing development.

Requires the Unity software version 2018.3.10f1 (or above).

Getting Started

Setting up a project

  • Using the Unity software version 2018.3.10f1 (or above), create a new project using the 3D Template or open an existing project.
  • If the project requires Virtual Reality support:
    • Ensure Virtual Reality Supported is checked.
      • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings window.
      • Select Player from the left hand menu in the Project Settings window.
      • In the Player settings panel expand XR Settings.
      • In XR Settings ensure the Virtual Reality Supported option is checked.
    • Ensure the appropriate support package is installed.
      • In the Unity software select Main Menu -> Window -> Package Manager to open the Packages window.
      • Find the appropriate support package in the left hand menu and click on it to select it (e.g. Oculus (Standalone) or OpenVR).
      • Click the Install button in the right hand pane of the Packages window for the selected support package.
      • The package will now install and be available for your supported hardware.
  • Ensure the project Scripting Runtime Version is set to .NET 4.x Equivalent.
    • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings inspector.
    • Select Player from the left hand menu in the Project Settings window.
    • In the Player settings panel expand Other Settings.
    • Ensure the Scripting Runtime Version is set to .NET 4.x Equivalent.

Cloning the Zinnia repo into a project

  • Navigate to the Assets/ directory of your project.
  • Git clone this repo into the Assets/ directory:
  • Wait for the Unity software to finish importing the cloned files.

Running the tests

  • In the Unity software select Main Menu -> Window -> Test Runner.
  • Within the Test Runner window click on the PlayMode tab and the click Run All button.
  • If all the tests pass then installation was successful.

Note: The tests are not compatible with the Run all in player option.

Contributing

We're not currently in a place where accepting contributions would be helpful. But as soon as we're ready we'll let you know!

Naming

Inspired by the Zinnia genus of plants known for their colorful, long lasting flower heads and their great ease to grow from seeds. This repository, much like the Zinnia flower aims to be easy to use and allow your projects to grow and flourish into long lasting, easy to maintain solutions.

Fun Fact: Zinnias have been grown aboard the International Space Station and have demonstrated the capability to blossom in a weightless environment.

License

Code released under the MIT License.

Disclaimer

These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.

You can’t perform that action at this time.