BeadMod Documentation

BeadMod Documentation

Welcome to the BeadMod user documentation! These guides help users understand and master the bracelet design tool.

📚 Available Guides

Getting Started

For: New users
Topics: Creating first design, onboarding tour, basic workflow
Read Time: 8 minutes

Perfect starting point for anyone new to BeadMod. Learn about the onboarding tour and create your first jewelry design step-by-step. Now includes information about product types and material effects!


Product Types Guide ⭐ NEW

For: All users
Topics: Bracelets, necklaces, rings, earrings, anklets - choosing and designing
Read Time: 12 minutes

Comprehensive guide to all 5 product types:

  • Bracelet (wrist jewelry)
  • Necklace (neck jewelry)
  • Ring (finger jewelry)
  • Earrings (ear jewelry)
  • Anklet (ankle jewelry)

Each with optimized layouts, camera angles, and design strategies.


Material Effects Guide ⭐ NEW

For: All users
Topics: 7 visual effects, custom presets, effect combinations
Read Time: 15 minutes

Master the stunning visual effects system:

  • 🌟 Glow - Emissive light
  • 🌈 Iridescent - Rainbow shimmer
  • ✨ Metallic Shimmer - Reflective sparkle
  • ❄️ Frosted Glass - Translucent appearance
  • 💎 Holographic - Prismatic shine
  • 🦪 Pearl Luster - Pearlescent sheen
  • 🚫 None - No effect

Plus custom preset save/load functionality!


Global Defaults & Sizing ⭐ NEW

For: All users
Topics: Global defaults system, XS-XL sizing scale, workflow strategies
Read Time: 10 minutes

Speed up your design workflow:

  • Set default materials, finishes, and sizes
  • Understand the XS (4mm) to XL (12mm) scale
  • Learn efficient design strategies
  • Override defaults on individual beads
  • Size selection guidelines by jewelry type

Bead Types Reference

For: All users
Topics: Complete guide to all bead types, usage tips, design patterns
Read Time: 10 minutes

Comprehensive reference for the 42+ beads in BeadMod's library:

  • Natural gemstones (Amethyst, Turquoise, Jade, etc.)
  • Wood beads (Oak, Bamboo, Sandalwood, Ebony)
  • Ceramic, Pearl, Glass, Resin, Metal
  • Material categories and finish types

Properties Guide

For: Intermediate users
Topics: Customization, materials, colors, advanced properties
Read Time: 15 minutes

Deep dive into bead customization:

  • Size adjustments (XS-XL)
  • Material types (7 categories)
  • Color theory and palettes
  • Finish types (7 finishes)
  • Material effects integration
  • Roughness, metalness, opacity
  • Property combinations

Studio Features

For: All users
Topics: HDRI environments, video recording, professional photography
Read Time: 10 minutes

Professional studio features for creating stunning visuals:

  • HDRI lighting environments
  • Lighting intensity and rotation
  • Turntable video recording
  • Screenshot best practices
  • Creative workflows

Performance Guide

For: All users
Topics: Performance optimization, presets, real-time stats
Read Time: 12 minutes

Understanding and optimizing 3D rendering:

  • Performance presets (Ultra, High, Medium, Low)
  • Advanced optimization techniques
  • Real-time performance monitoring
  • Troubleshooting performance issues
  • Hardware recommendations

Loom Designer - AI Features ⭐ NEW

For: Loom design users
Topics: Image-to-pattern conversion, AI pattern generation, Gemini AI
Read Time: 20 minutes

Complete guide to AI-powered loom pattern creation:

  • 📸 Image-to-Pattern: Convert photos to bead patterns
  • AI Generator: Create patterns from text prompts
  • Advanced settings and customization
  • Tips for best results
  • Example prompts and workflows

Loom AI Quick Reference ⭐ NEW

For: Loom design users (quick lookup)
Topics: Cheat sheets, quick tips, example prompts
Read Time: 3 minutes

Fast reference for loom AI features:

  • One-page cheat sheet
  • Settings quick reference
  • Example prompt library
  • Troubleshooting guide
  • Keyboard shortcuts

FAQ

For: All users
Topics: Common questions, troubleshooting, account info
Read Time: 5-10 minutes (browse as needed)

Quick answers to frequently asked questions about:

  • Getting started
  • Design questions
  • Customization
  • Export and sharing
  • Technical issues
  • Account and billing

📖 Documentation Guidelines

Writing Style

  • Simple: Easy for all ages to understand
  • Visual: Describe what users will see
  • Actionable: Clear steps and examples
  • Friendly: Conversational, encouraging tone

Content Structure

Each guide includes:

---
title: Page Title
description: Brief description for SEO
---

# Main Heading

Brief introduction...

## Section Headings

Content with examples...

Adding New Documentation

When adding new features to BeadMod:

  1. Update relevant guides with new functionality
  2. Add to FAQ if it's commonly asked
  3. Create new guide for major features
  4. Update this README with new content

Markdown Features

Use these for better documentation:

# Headers
## Subheaders

**Bold text**
*Italic text*

- Bullet lists
1. Numbered lists

[Links](./other-page.md)

> Blockquotes for important notes

\`\`\`javascript
// Code blocks
const example = "code"
\`\`\`

🔗 Documentation Access

Users can access this documentation at:

  • /docs/getting-started - Start here!
  • /docs/product-types - Product types guide ⭐ NEW
  • /docs/material-effects - Effects system ⭐ NEW
  • /docs/global-defaults - Defaults & sizing ⭐ NEW
  • /docs/loom-ai-features - Loom AI features guide ⭐ NEW
  • /docs/loom-ai-quick-reference - Loom AI quick reference ⭐ NEW
  • /docs/bead-types - Bead library reference
  • /docs/properties-guide - Customization guide
  • /docs/studio-features - HDRI & video recording
  • /docs/performance-guide - Optimization tips
  • /docs/faq - Common questions

Or through the Help menu in the application.


✨ Recent Updates

November 8, 2025 - AI-Powered Loom Features:

  • ✅ Added Image-to-Pattern conversion with advanced adjustments
  • ✅ Added AI Pattern Generator powered by Gemini AI (Flash & Pro models)
  • ✅ Created comprehensive AI features documentation
  • ✅ Added quick reference guide for loom AI tools
  • ✅ Integrated both features into Loom Designer sidebar

November 1, 2025 - Major Feature Release:

  • ✅ Added Product Types system (5 jewelry types)
  • ✅ Added Material Effects (7 visual effects)
  • ✅ Added Global Defaults system
  • ✅ Added Custom Effect Presets
  • ✅ Added Onboarding Tour for new users
  • ✅ Created comprehensive new documentation

🎯 Quick Start Path

New to BeadMod? Follow this documentation path:

  1. Getting Started - Learn basics + onboarding tour
  2. Product Types - Choose your jewelry type
  3. Global Defaults - Set up efficient workflow
  4. Material Effects - Add stunning effects
  5. Studio Features - Create beautiful renders

💡 Documentation by Goal

I want to learn the basics: → Getting Started

I want to design a necklace/ring/earrings: → Product Types Guide

I want to create loom patterns with AI: → Loom AI Features Guide or Quick Reference

I want to convert an image to a bead pattern: → Loom AI Features - Image-to-Pattern

I want to generate patterns from text descriptions: → Loom AI Features - AI Generator

I want to add special effects to my beads: → Material Effects Guide

I want to speed up my design workflow: → Global Defaults & Sizing

I want professional photos/videos: → Studio Features

I'm experiencing performance issues: → Performance Guide


✨ Future Documentation

Planned additions:

  • Design Pattern Library
  • Video Tutorials (embedded YouTube)
  • Community Showcase Gallery
  • Advanced Techniques (gradients, patterns)
  • Keyboard Shortcuts reference
  • Export and Sharing workflow
  • API Documentation (for developers)
  • Mobile App Guide (when available)

Last Updated: November 1, 2025
Maintained By: BeadMod Development Team