# 🛠️ OSSM Configurator

[![Project Version](https://img.shields.io/badge/version-0.0.1--beta-blue.svg)](https://github.com/KinkyMakers/OSSM-Configurator)
[![License](https://img.shields.io/badge/License-OSSM-green.svg)](https://github.com/KinkyMakers/OSSM-Configurator)

A professional web-based configuration tool for the **Open Source Sex Machine (OSSM)** project. This application provides a premium, intuitive wizard interface that guides users through the complex process of selecting, customizing, and validating components for their OSSM build.

---

## 🌟 Key Features

- **Intuitive Wizard Flow**: Step-by-step guidance from motor selection to final export.
- **Dynamic 3D Visualization (Coming Soon)**: Preview your build with real-time color updates.
- **Smart Compatibility**: Ensures your PSU matches your Motor and your Mount fits your Actuator.
- **Rich BOM Export**: Download a complete ZIP package containing:
  - 📄 **README.md** overview of your build.
  - 📊 **Excel BOM** for hardware ordering.
  - 🖨️ **Print List** with filament estimates.
  - 📁 **Organized STL Files** categorized by component and color.
- **Vendor System**: Integrated tracking for external CAD files to ensure reproducible builds.
- **Dark Mode Support**: A premium aesthetic designed for builders, day or night.

---

## 📸 Guided Walkthrough

### 1. Component Selection
The wizard starts with core hardware. Select your motor and power supply with real-time feedback on compatibility and cost.

![Motor Selection](./Screen%20Shots/Motor-Selected.png)
*Figure 1: Motor selection with clear technical specs and visual feedback.*

![PSU Selection](./Screen%20Shots/PSU%20selector.png)
*Figure 2: Choosing a compatible power supply (24V or USB-C PD).*

### 2. Aesthetic Customization
Choose your Primary and Accent colors. These selections automatically update the filament estimates in your final BOM.

![Color Selection](./Screen%20Shots/Color%20Selector.png)
*Figure 3: Interactive color picker for 3D printed components.*

### 3. Detailed Options
Configure every aspect of your machine, from the stand type to specialized toy mounts.

![Options Selection](./Screen%20Shots/Options%20List.png)
*Figure 4: Browsing the extensive list of compatible add-ons and variations.*

### 4. Final Summary & Export
Review your entire build, total cost, and total filament weight before exporting your build package.

![BOM Summary](./Screen%20Shots/Summary.png)
*Figure 5: The comprehensive BOM summary with automated ZIP generation.*

---

## 🚀 Getting Started

### Quick Start (Docker)
The easiest way to run the configurator locally:

```bash
docker-compose -f docker-compose-dev.yml up -d
```
Access the app at `http://localhost:5173`.

### Local Development
1. **Clone the repo**
2. **Setup Website**:
   ```bash
   cd website
   npm install
   npm run dev
   ```
3. **Setup Logic** (Optional, for vendor updates):
   ```bash
   cd scripts
   pip install -r requirements.txt
   python vendor_update.py
   ```

---

## 🗺️ Project Roadmap

We are constantly improving the OSSM Configurator. Check out our **[detailed roadmap](./roadmap/ROADMAP.md)** for upcoming features, including:
- 🛠️ Interactive 3D Render/Preview
- 🌍 Multi-language & Multi-currency support
- 📦 Integrated assembly guides

---

## 🤝 Contributing

Contributions are welcome! Whether you are adding a new remote, a toy mount, or a hardware mod, please refer to our detailed guide:

👉 **[Read the CONTRIBUTING.md](./CONTRIBUTING.md)**

### Quick Summary:
1. Update JSON data in `website/src/data/`.
2. Add relevant images to `website/public/images/`.
3. Run `python scripts/vendor_update.py` for new files.
4. Submit a PR!

---

## 📜 License

This project is part of the **Open Source Sex Machine (OSSM)** project. Please refer to the main OSSM project for full license details.

---
*Built with ❤️ by the OSSM Community.*