/text-to-cad-blender-addon

A Blender plugin to interact with the text-to-cad API

Primary LanguagePythonMIT LicenseMIT

Zoo Logo

Zoo's Text To CAD Plugin For Blender

A Blender plugin to interact with Zoo's Text-to-CAD API, brought to you by the Zoo Team

Table of Contents

Prerequisites

  1. Create an account at zoo.dev/signup
  2. Create an API token for your account at zoo.dev/account/api-tokens
  3. Add your API token to your environment with the name KITTYCAD_API_TOKEN

Installation

Download the text_to_cad.py from src

Open the preferences menu in Blender. Edit -> Preferences

Select the Addons tab and click the Install button

Navigate to your downloaded text_to_cad.py and Install Add-on

Make sure the Text To CAD addon is enabled by checking the box next to the plugin

Usage

The plugin can be accessed via shortcut ctrl + shift + T or while in Object Mode under the Add Menu

NOTE: This plugin may take several minutes to run while your prompt is processing. Please check your dashboard for progess

There are 3 inputs to this plugin

  • The text prompt:
    • Describe an object that can be represented in geometric shapes, not nebulous concepts such as "a tiger" or "the universe", unless you're just curious what it does with that 😏
    • Be as explicit as possible. For example, if you want a plate with 4 holes, say where you want the holes placed and how big of a diameter each should have
    • Our ML models are better at describing single objects than assemblies for now
  • The output format:
    • This is required as the model needs to be downloaded and saved locally.
  • The output directory:
    • Where the downloaded model should be saved. If you need to re-access this model for any reason or want to download in a different format you can go back to your dashboard

Contributing

Before you submit a contribution PR to this repo, please ensure that:

  • There is a corresponding issue for the changes you want to make, so that discussion of approach can be had before work begins.
  • You have separated out refactoring commits from feature commits as much as possible