ryOS ryOS / Docs
GitHub Launch

Stuff

Stuff is a comprehensive inventory management application for ryOS that utilizes a skeuomorphic wooden shelf interface to organize physical belongings. It combines advanced barcode scanning with social sharing features to bridge the gap between physical objects and digital organization.

Overview

The Stuff app provides a tactile way to track, value, and organize your personal inventory. By representing items on a virtual wooden shelf, users can visually browse their collections, manage storage locations, and categorize items using a flexible tagging system. Whether you are cataloging a home library, tracking electronics, or managing a small resale business, Stuff provides the tools to maintain a detailed digital record of your physical assets.

Beyond simple tracking, Stuff integrates with the web-browser capabilities of ryOS to offer powerful automation. It can look up product details via barcodes, generate printable labels for physical organization, and even publish selected items to a public URL where others can reserve items or place bids. This makes it an all-in-one solution for both personal organization and peer-to-peer commerce.

Features

  • Visual Inventory Management: A rich, wooden-shelf UI that displays items with "cutout" covers and status ribbons.
  • Intelligent Barcode Scanning: Support for UPC, EAN, Code 128, and QR codes using the device camera to automatically fetch product metadata.
  • Comprehensive Tracking: Log original prices, discounted rates, and final sale prices while tracking the lifecycle of an item (In Use, Stowed, For Sale, Sold, or Discarded).
  • Organization Tools: Filter items by custom tags (e.g., "Kitchen," "Electronics") or physical locations using the integrated sidebar.
  • Public Sharing & Bidding: Generate public URLs for specific inventory items, allowing visitors to reserve items or place the highest offer.
  • Physical Labeling: Generate and print ryOS ID barcodes. Scanning these physical labels later will automatically open the item or filter the shelf by the associated tag.

User Guide

Getting Started

To begin, launch Stuff from your ryOS App Drawer. You can immediately start adding items by clicking the "Add" button or by navigating to File ▸ Scan Barcode to use your camera for automatic product entry.

Key Actions

  • Editing Items: Click any item on the shelf to open the Detail Panel. Here you can change the item's cover image, adjust its status, and update pricing information.
  • Scanning: Use the Barcode Scanner to quickly ingest new items. When a barcode is recognized, the app attempts to perform a product lookup to fill in titles and descriptions automatically.
  • Sharing: Open the Share Dialog to publish your items to the web. This is ideal for garage sales or sharing a collection with friends.
  • Printing: Use the Print menu to create physical labels. These labels help you find items later by linking the physical object back to its digital entry in ryOS.

Tips & Shortcuts

  • Sidebar Filtering: Use the sidebar to quickly toggle between different categories. The "Sold" and "Stowed" filters help declutter your main shelf.
  • Status Ribbons: Look for colored ribbons on the item covers to quickly identify which items are currently for sale or have already been sold.
  • Auto-Enrichment: When adding books or media, the barcode scanner often pulls high-quality cover art, saving you the time of manual uploads.

Technical Details

Window Configuration

  • Default Size: 920 × 580 px
  • Minimum Size: 560 × 400 px

Component Architecture

The app consists of 10 primary components:
  • StuffSidebar.tsx: Navigation and tag filtering.
  • StuffAppComponent.tsx: The main entry point and window wrapper.
  • StuffProductLookupDialog.tsx: Interface for external product API searches.
  • StuffShareDialog.tsx: Configuration for public item sharing.
  • StuffDetailPanel.tsx: The slide-out drawer for editing item metadata.
  • StuffSharedView.tsx: The public-facing view for shared items.
  • StuffBarcodeScanner.tsx: Camera interface for ZXing-based scanning.
  • StuffShelfView.tsx: The main wooden shelf rendering engine.
  • StuffMenuBar.tsx: Application-level menus and actions.
  • StuffItemCover.tsx: Handles the visual rendering and "cutout" effects of item images.

Hooks & Utilities

Custom Hooks:
  • useStuffLogic.ts: Centralizes state management for the shelf, selection, and dialogs.
  • useStuffCoverIsCutout.ts: Logic to determine if an image should have background removal applied.
  • useStuffItemCoverSrc.ts: Resolves image paths and blobs for item covers.
Key Utilities:
  • barcodeLookup.ts & enrichItemFromLookup.ts: Handle external API communication.
  • printLabels.ts: Manages the generation of printable PDF/HTML label sheets.
  • stuffShelfImportExport.ts: Handles data portability for the inventory.
  • stuffCoverCompress.ts: Optimizes images for storage within the ryOS environment.

State Management

Stuff utilizes a centralized logic pattern via the useStuffLogic hook. It manages local UI state (such as the currently selected item and active filters) while interfacing with ryOS storage to persist the inventory database. It also handles the orchestration of sound effects for UI transitions like opening the detail drawer.

Related Apps

  • Camera: Used by Stuff for capturing custom item photos and scanning barcodes.
  • Files: Useful for managing exported inventory manifests and backup files.