🚀 Welcome to Rush Assets Docs

Explore our newly designed documentation hub! Whether you're just getting started or diving into advanced features, this site is your go-to guide for everything Rush Assets.

✨ What's New?

Our redesigned docs site is more user-friendly, with intuitive navigation and detailed guides. We've made it easier to find what you need, whether you're looking for setup instructions or deep-dive tutorials.

• Comprehensive Guides: Step-by-step instructions to help you get the most out of our assets.
• Interactive Demos: Test and explore features directly from the documentation.
• Search Functionality: Quickly find answers with improved search capabilities.
• Visual Overviews: Clean diagrams and screenshots to guide your learning.

Meet our Docs Website

💡 Getting Started

If you're new here, we recommend starting with our Getting Started guide. It covers the basics of verifying and gaining access to our assets, so you can be up and running in no time.

Start Here →

🔍 Dive Deeper

For advanced users, we have detailed documentation on specific features like Grid Inventory, Audio Systems, and Input Configurations. Our docs are structured to grow with your knowledge—whether you're a beginner or an expert.

Explore the Docs →

---

🔧 Need Help?

If you run into any issues or have questions, don't hesitate to reach out to our support team. We are constantly updating our documentation based on user feedback, so feel free to suggest improvements.

Contact Support →

Happy Developing! 🚀

Docs Changelog - Version 1.9.0

We are excited to introduce seamless integration with Amplitude on our documentation website! This update allows us to track user engagement and analyze data effortlessly, providing valuable insights to enhance your experience.

Key Changes:

• Page Render Time Tracking: We now track the time it takes to render the documentation page.
• Feature Flags and A/B Testing: Amplitude integration enables us to implement feature flags and conduct A/B tests for continuous improvements.

How to Get Support:

If you have any questions or encounter issues related to this update, please contact us at rushassets@gmail.com for prompt assistance.

We appreciate your continued support and are committed to providing a secure and seamless experience on our website.

Docs Changelog - Version 1.8.0

This update enhances usability with a redesigned interface where the sidebar is detached from the documentation page, leading to improved navigation and a faster loading experience.

Key Changes:

Improved User Experience:

• Sidebar Detachment: The sidebar has been detached from the documentation page, significantly improving navigation and reducing page load times.

How to Get Support:

If you have any questions or encounter issues related to this update, please contact us at rushassets@gmail.com for prompt assistance.

We appreciate your continued support and are committed to providing a secure and seamless experience on our website.

Docs Changelog - Version 1.7.0

This bugfix update introduces an automatic scroll-to-top feature that activates smoothly each time the page is changed, ensuring a more seamless and user-friendly browsing experience.

Key Changes:

Improved User Experience:

• Fix: Added auto-scroll to the top when changing pages. This update addresses the previous issue where auto-scroll was not functioning correctly, improving the overall browsing experience.

How to Get Support:

If you have any questions or encounter issues related to this update, please contact us at rushassets@gmail.com for prompt assistance.

We appreciate your continued support and are committed to providing you with a secure and seamless experience on our website.

New Features and Improvements:

1. Enhanced Documentation:

• Overhauled and improved for a more comprehensive and user-friendly experience.
• Added clearer instructions and more examples to facilitate quick setup.
• Updated troubleshooting sections for improved support.

2. Simplified Asset:

• Streamlined interface for improved usability and reduced complexity.
• Redesigned key components based on user feedback to optimize workflows.

User Interface Enhancements:

New UI in a MockupLoading image

• The updated UI offers a cleaner and more organized layout, enhancing navigation and accessibility.

A Better Documentation:

New Documentation in EbookLoading image

• Includes visual aids and step-by-step guides for a smoother user experience.
• Added screenshots and diagrams to clarify key concepts and workflows.

Bug Fixes and Optimizations:

• Resolved reported bugs and issues for increased stability and reliability.
• Enhanced performance for better responsiveness and efficiency.

Docs Changelog - Version 1.6.0

We’re excited to announce the release of version 1.6.0 for our docs website, featuring a major upgrade to our authentication system. We have transitioned from NextAuth to Auth0, a leading platform for authentication and authorization, to enhance security, reliability, and user experience.

Key Changes:

Authentication System Upgrade:

• Migrated from NextAuth to Auth0 for improved authentication and authorization.
• Auth0 brings advanced features, robust security, and a seamless user experience.

Enhanced Security Measures:

• Auth0 adheres to industry-leading security standards to ensure user data confidentiality and integrity.
• Added multi-factor authentication for additional protection.

User Impact:

No Impact on Users:

• This upgrade will not affect your current experience on the website.
• You can continue to use the website as usual with no changes to your login process.

Improved User Experience:

• Auth0 offers a smoother and more intuitive login experience.

How to Get Support:

If you have any questions or issues related to the authentication system transition, please contact us at rushassets@gmail.com for prompt assistance.

We appreciate your support and are committed to delivering a secure and seamless experience on our website.

Refactors, Editors, and Drawers

What's Changed

In this update, we've made significant enhancements to UGI, focusing on improving grid and separation logic. Here’s a summary of the key changes and additions:

Improvements

• New Editors: Added editors specifically for business classes to streamline editing.
• Bug Fix: Resolved a foreach loop issue for single iteration.
• Code Simplification: Removed unnecessary properties to enhance maintainability.
• Property Drawers: Improved InventoryMetadataPropertyDrawer and GridTablePropertyDrawer; introduced ContainerMetadata drawer.
• Error Handling: Added a new catch clause for better error management.
• Editor Adjustments: Fixed height-related issues and introduced a table drawer helper.
• Code Cleanup: Removed unnecessary imports and resolved annotation issues.
• Ongoing Improvements: Continued enhancements to various editors, including ContainerMetadata, and refinements to the grid table inventory.
• GridTable Editor: Added a new editor to manage and configure grid tables effectively.
• Input Events: Fixed input events for item placement and pickup.
• UI Refinements: Improved the behavior of the close button in the help modal and introduced initial controller support.

Additionally, we’ve introduced an input provider architecture, paving the way for easier integration with other projects and supporting multiple input providers. More improvements to this architecture are planned for future releases.

These updates underscore our commitment to enhancing user experience, code quality, and functionality. We will continue to refine and innovate, aiming to deliver a more robust and user-friendly grid inventory solution.

Introducing a More Seamless User Experience: Sidebar Update

We're excited to announce a major update to the user interface of our documentation website. In response to user feedback and research, we have revamped the sidebar to enhance usability and improve your browsing experience.

Sidebar Relocation for Enhanced Usability

The sidebar has been moved from the right side of the content to a new, fixed position on the left side of the page. This change is aimed at making your interaction with our documentation more intuitive and accessible.

"On This Page" - Your Instant Guide

We’ve introduced a new "On This Page" component in the space previously occupied by the old sidebar. This feature provides a dynamic list of topics and sections currently visible on your screen, allowing for quick and easy navigation.

Seamless Browsing, Uninterrupted Exploration

With the sidebar now fixed in its new location, your browsing experience remains uninterrupted. You can explore various topics with ease, as the sidebar and "On This Page" guide stay in view to provide essential navigation options.

A Focus on What Matters: Your Content

The core of this update is to enhance your focus on the content. By relocating the sidebar and adding the "On This Page" guide, we ensure a smooth and engaging reading experience, making it easier to access and navigate through our documentation.

This update aims to streamline your interaction with our documentation website, making navigation more intuitive and content-focused. Here’s to a more user-friendly browsing experience!

Sonar Analysis Pipeline 🧪

We’ve integrated SonarQube to enhance our code quality through continuous static analysis. SonarQube helps us identify bugs, code smells, and various issues by examining code quality, duplication, adherence to coding standards, unit tests, code coverage, complexity, and more.

With this integration, we now have valuable data to improve our code, ensuring a higher quality asset for you! 🫶

SonarSource latest activitiesLoading image

DevOps! 🎉🎉

We've introduced a new DevOps feature using GitHub Actions! This enhancement will streamline our release and versioning processes, as well as automate the build and validation of our code.

Key Improvements:

• Added a build step to automate the creation of builds.
• Implemented a validation step that runs tests to ensure code quality.

GitHub Actions showing success results!Loading image

Refactoring and Removing UI Dependency

Changes

• Moved icon sizes from the main folder ← dab1b1b
• Fixed demo issues ← 013cd74
• Renamed various elements ← a7aa0d7
• Added null validation checks ← 184d0e6
• Added default settings and fixed dirty state issues ← d96826f
• Fixed UI bug ← facb0bc
• Resolved UI refresh problem ← dfe2aae
• Added demo content ← eaa8937
• Removed build.zip from .gitignore ← d696b05
• Fixed various bugs ← 7108345
• Created datasource and reorganized UI folder ← 3501f3c
• Fixed discard function when windows are open ← 167150e
• Renamed and reorganized folders ← a1bc9a3
• Fixed item holder bug and made code improvements ← f83d4eb
• Resolved item holder bug ← 665cb38
• Updated build properties ← cf50556
• Modified packages ← 5eae663
• Removed RectTransform from draggable controller ← aa967d9
• Removed outdated dependencies in Draggable Controller ← 9bd9d6b
• Updated InventorySo to depend only on domain classes ← 977b74e
• Changed Metadata to no longer use MonoBehavior and removed UI dependency ← 6c3c29a
• Added more inventory features ← 5ef56f8
• Added TODO in IsInsertingInsideYourself method ← 50758c4
• Refactored inventory item handling ← 419cabd
• Refactored InventoryItem to AbstractItem ← 7918005
• Continued refactoring efforts ← 70117fb
• Further refactoring updates ← 6eb2591
• Added gitignore for code coverage ← 25a191f
• Implemented container grids in creation game objects ← 7bb9fb6
• Added Create Grid and Discard functions ← a965ce5

We Are Happy to Announce Our New Documentation Website

All new assets will now be documented on Docs RushAssets! This upgrade will enhance both the quality and accessibility of our documentation.

Check out the website's interface:

Website faceLoading image

Improved Documentation for Ultimate Grid Inventory!

We’re excited to announce that the Ultimate Grid Inventory now has enhanced documentation, available through Docs RushAssets. This new platform allows us to provide faster updates and easily add new content, especially with your feedback through email or surveys.

Going forward, all our assets will be documented on the Docs RushAssets website.

Access the Ultimate Grid Inventory Docs now! If you don't have access yet, you can explore the general documentation at the Docs RushAssets Website.

After validating your invoice number on Docs RushAssets, you’ll gain access to the Ultimate Grid Inventory Docs!

Showing Getting Started PageLoading image

New User Interface

Inventory with Items

Inventory with ItemsLoading image

Containers Window

• Opened Containers: Opened ContainersLoading image
• Container Options: Options ContainerLoading image
• Drag & Hover Insertion: Insert by drag hoverLoading image

Inspect Window

Inspect WindowLoading image

Highlight Feature

HighlightLoading image

---

New Showcase

Check out the latest showcase on YouTube:

🪲 Bugfix: Container Issue

The Issue

Previously, you could place one backpack inside another, even if both were in the same hierarchy of containers. This behavior was unintended, allowing you to insert a backpack within another, regardless of the container's hierarchy level.

The Fix

This issue has been resolved, and now backpacks (or any container items) cannot be nested within each other, ensuring proper inventory management.

Check the video below to see the bug in action:

🎧 Audio System

We have developed an audio system based on Scriptable Objects.

❗ Important Classes

AudioSo: Holds the audio settings for an AudioClip.
AudioSoLoading image

AudioStateSo: Manages multiple AudioSo objects, allowing for random or sequential playback of clips to enhance user experience.
AudioStateSoLoading image

AudioCueSo: Contains two AudioStateSo objects—onBeingPlace and onBeingPicked. This is used in the Draggable Controller to trigger audio during interactions.
AudioCueSoLoading image

---

⚙️ Options System Refactor

The Options System has been refactored to use Scriptable Objects, making it easier to add options to items. Simply create an OptionSo Scriptable Object and add it to the options property in ItemDataSo.

Items

• Potion Item
  Potion Item in demoLoading image

• Backpack Item
  Backpack Item in demoLoading image

---

➕ Additions & Changes

Added: Inventory Audio Controller

An Inventory Audio Controller has been added to the InventoryManager prefab, along with an Audio Source as a child component to manage audio playback (making it easy to add your own audio source).

Draggable Controller Updates

Minor updates have been made to the Draggable Controller to trigger the onBeingPlace and onBeingPick events. Audio feedback is also applied to actions like equipping/unequipping in Container Holders.

New Wav Files

We've added several WAV files to provide default audio effects for items.

Content

Note:

• A good understanding of C# will help you use the project in a more effective manner, but it is not a requirement.
• This asset will be upgraded... So expect improvements from time to time

📚 Overview

It includes some basic/useful scripts that make inventory works pretty well. Unique and customizable tiled inventory with default tile images.

🎨 Visuals & Art

• Basic Tile art
• Basic Items/Containers Art

🖥️ UI Icons & HUD

• Items Art
• Container Open Window
• Inspect Window
• Right Click UI
• And more...

🕹️ Functionality

🎒 Grid Inventory

A system that allows for devs to create their own grid inventory and set that item as a Container where the player can hold.

🔦 Holders

Holders where the player can equip a container as a backpack equip...

🔧 Draggable System

Draggable System or Clicky System in order to move items in the inventory...

You can should between hold to drag the item or just click once to drag.

👆 Right Click Options

Quick actions in the right click

Features:

• Equip
• Open
• Inspect
• Discard
• And easy to implement more!

⌨️ Input System

Better with New Input System! This asset was created in old input system but it was thought to easy change to other input system.

---

More are coming! (We are working on improve this documentation as well create more features to Ultimate Grid Inventory)