Skip to content

alon-mini/MiniforgeDesktop

Repository files navigation

Miniforge Studios Desktop

Miniforge Banner

Miniforge Studios is a powerful desktop application designed for Tabletop RPG enthusiasts and game masters. It leverages cutting-edge AI pipelines to generate high-quality 2D character portraits and 3D printable models from simple text prompts.

Built with Electron, React, and Vite, it offers a native desktop experience with secure local storage, offline capabilities (for viewing assets), and a sleek, sci-fi inspired UI.

🚀 Features

  • AI Forge Engine: Generate unique character art using models like Nano Banana Pro, Imagen 4, and Flux-2-Pro.
  • 3D Sculpting Matrix: Create 3D assets (GLB/OBJ/STL) using Rodin, Hunyuan 3D, Meshy, and Trellis 2.
  • Local Armory: A persistent gallery to store, view, and organize your generated assets locally.
  • Secure Vault: API keys are encrypted using OS-level security (SafeStorage) and never stored in plain text.
  • 3D Viewer: Integrated Three.js viewer to inspect, rotate, and zoom into your 3D models before downloading.
  • Export Ready: Download assets in standard formats (.png, .stl, .obj, .glb) ready for VTTs or 3D printing.

🛠️ Prerequisites

📦 Installation & Setup

  1. Clone the repository

    git clone https://github.com/MiniforgeStudios/desktop-app.git
    cd desktop-app
  2. Install Dependencies

    npm install

    Note: If you encounter issues with native modules, ensure you have build tools installed for your OS (Visual Studio Build Tools for Windows, Xcode for macOS).

  3. Run in Development Mode This starts the Vite dev server and launches the Electron window.

    npm run dev

🏗️ Building for Production

To create a distributable installer / executable for your operating system:

npm run build
  • Windows: Generates an NSIS installer in dist-electron/.
  • macOS: Generates a DMG or ZIP (requires code signing config for distribution).
  • Linux: Generates AppImage/Deb.

⚙️ Configuration

Miniforge Studios is designed to be "Bring Your Own Key" (BYOK). We do not provide AI generation credits.

  1. Launch the application.
  2. Navigate to Preferences (Settings) via the Sidebar.
  3. Under Cloud Integrations, enter your API keys.
  4. Click Save Configuration. Keys are encrypted and stored safely on your device.

🧩 Tech Stack

📂 Project Structure

├── components/        # React UI components (Sidebar, Viewer, Gallery, etc.)
├── dist/              # Compiled frontend assets (Vite output)
├── dist-electron/     # Compiled Electron main process and installers
├── main.js            # Electron main process entry point
├── preload.js         # Electron context bridge (security sandbox)
├── generationService.ts # AI API integration logic (Replicate, Fal, etc.)
├── storageService.ts  # Persistence layer (Settings, Assets, Auth)
├── constants.tsx      # App configuration, model definitions, image paths
└── App.tsx            # Main React application entry

📄 License

This project is licensed under the gpl-3.0 license.


Created by Miniforge Studios