Skip to content

LloydDavid/jewelcraft

Repository files navigation

JewelCraft—jewelry design toolkit add-on for Blender.

Features:

  • Create and customize gems, prongs and cutters. [▸]
  • Organize library of components using in add-on asset manager. [▸]
  • Manage distances between gems to create compact setting. [▸]
  • Calculate weight in a variety of precious alloys.
  • Generate color-coded gem map. [▸]
  • Present summary information about your design. [▸]
  • Translated to multiple languages:
    • 100% English
    • 100% Russian
    • 95% Arabic
    • 80% Italian
    • 72% French
    • 65% Spanish
    • 57% Simplified Chinese
    • Your language is missing or incomplete? Contribute translation.

How to install

  1. Download JewelCraft 2.12.1
  2. Make sure you have Blender 3 or newer.
  3. Open PreferencesAdd-ons category.
  4. Use Install to install add-on from downloaded zip archive.2
  5. Check known issues.

1 Note for mac users: Safari browser will automatically unpack downloaded zip archive, so in order to install the add-on, you have to pack folder with add-on files back into zip archive. Or use a different browser to download add-on.

2 If error occurs on add-on activation, it means you are trying to install add-on repository instead of release. Make sure you download add-on release using link provided in step one of this guide.

Установка

  1. Загрузите JewelCraft 2.12.1
  2. Убедитесь, что у вас установлен Blender 3 или новее.
  3. Откройте PreferencesAdd-ons.
  4. Воспользуйтесь Install чтобы установить аддон из загруженного архива.2
  5. Ознакомьтесь с известными проблемами.

1 Примечание для пользователей mac: браузер Safari автоматически распаковывает скачиваемые zip архивы, поэтому, чтобы установить аддон, необходимо запаковать папку с файлами аддона обратно в zip архив. Или используйте другой браузер для скачивания аддона.

2 Если при активации аддона возникает ошибка, значит вы пытаетесь установить репозиторий вместо релиза. Для загрузки релиза используйте ссылку, приведённую в первом шаге данного руководства.

Contributing

Did you find a bug?

  • Check known issues.
  • Ensure the bug can be reproduced in the latest add-on version.
  • Open new bug report, be sure to include Blender and add-on versions, and screenshot showing the error message.

Known issues

  • Design Report/Gem Map/Spacing Overlay
    • [T74368] Gems from hidden collections appear in report/Spacing Overlay, this happens when collection is hidden with Hide in Viewport (eye icon), instead use Disable in Viewports (display icon) or Exclude from View Layer (checkbox).

Translations

  • It is advised that you use a dedicated .po editor like Poedit.
    • To create new transltation in Poedit use FileNew from POT/PO file, then pick .po file from add-on localization folder (doesn't matter which one).
    • To complete existing transltation in Poedit use FileOpen, then pick .po file for specific language from add-on localization folder.
  • Translating tips:
    • The UI convention for English language is to use Title Case formatting for property names and button titles, to know formatting convention for your language just see how Blender handles it and follow the rule.
    • Preserve empty braces {} in translation, they used as placeholders for additional information and will not appear in UI.
    • Look out for appropriate context, Base for example is used in the context of materials as Base Metal, which in other words means Non-Presious Metal and should not be translated as Basis or Foundation.
    • If you have limited amount of time to work on translation, then make sure to prioritize in the following order:
      • Essentials: add-on sidebar UI, gem names and cuts.
      • Good to have: tool popups and modal UI, add-on preferences, precious alloys, error messages.
      • The rest: tooltips and other UI messages.
  • After translation is done submit it back through issues.

About

Blender add-on for jewelry design

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%