🚀 CDI Toolkit for Unity

Welcome to the CDI Toolkit for Unity!

This toolkit is your go-to resource for streamlining the development of Computational Design Institute (CDI) - Dreamship Projects for Pediatric Palliative Care, in Unity.

It includes a comprehensive and ongoing collection of reusable tools, scripts, samples, settings, and resources to supercharge your Unity development.

✨ Features

🔧 Reusable Tools

• Camera Controls: Implement intuitive camera movement and controls.
• Fade Material: Create fade effects for sequencing.
• FPS Counter: Display real-time frames per second on your UI.
• Editor Config: Standardize project settings for a consistent development experience.
• Gaze Input Module: Implement gaze-based input for VR projects.
• Indexed Collections: Simplify the management of collections in your project.
• Time Scaler: Control the timescale of your project for slow motion, fast-forwarding or pausing.
• Particle System Controller: Control particle systems with ease.
• XR Rig: Implement a ready-to-use XR rig for VR projects.

💻 Scripts

• Audio Management: Tools for managing audio in your project.
• Collection Management: Simplify the management of collections in your project.
• Debugging: Tools for debugging and testing your project.
• Event Management: Decouple components and streamline communication in your projects.
• GameObject Management: Simplify the management of GameObjects in your project.
• Input Handling: Unified input management for multiple platforms, including VR and gamepads.
• Mathematics: Common math constants and extensions for your project.
• Randomness: Tools for generating random values.
• Rendering: Tools for managing rendering.
• Sequencing: Tools for managing sequences and timelines.
• Time Management: Tools for managing time and time-based events.
• Transform Management: Tools for managing transforms.
• VFX Management: Tools for managing visual effects.

🎨 Samples and Resources

• Models: Ready-to-use models and assets for prototyping and development.
• Prefabs: Drag-and-drop components for quick integration.
• Textures and Materials: Enhance the look and feel of your project with our curated collection.

⚙️ Settings and Configuration

• Input Actions: Ready-to-use input actions for common interactions.

📦 Installation

Option 1: Clone to Assets Folder

git clone https://github.com/CDInstitute/CDIUnityToolkit.git

Don't forget to import the dependencies listed in the package.json file via the Unity Package Manager.

Option 2: Add as a Unity Package

1. Open the Package Manager in Unity.
2. Click on the + button and select Add package from git URL.
3. Enter the following URL: https://github.com/CDInstitute/CDIUnityToolkit.git.

🚀 Getting Started

1. Explore the Samples
   Start by exploring the assets in our Samples folder. These will give you a solid foundation for integrating the features into your own project.

2. Use Prefabs
   Drag and drop prefabs from the Prefabs folder into your scene to quickly add functionality.

3. Leverage Scripts
   Utilize the scripts to implement essential features like event management or save time with extension methods.

4. Customize
   Tailor the toolkit to your needs by modifying settings and scripts, or adding your own custom resources. You can always copy samples and modify them to suit your project.

💡 Experience Use Cases

Restful Dreams
Immersive calming experiences for pediatric palliative care patients.

Playful Dreams
Interactive experiences for children to engage with and distract from their pain.

Lucid Dreams
Empower children to be the hero of their stories through super human abilities.

🤝 Contributing

We welcome contributions to the toolkit! If you’d like to contribute, please fork the repository and submit a pull request.

🛠️ Support

If you encounter any issues or have questions, feel free to open an issue in this repository.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Acknowledgments

CDI Team