diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index fa738e45..2ed40b4e 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -69,6 +69,7 @@ export default defineConfig({ { text: 'Contact Sheet', link: '/addons/contactsheet'}, { text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'}, { text: 'Grase Converter', link: '/addons/grease_converter'}, + { text: 'Lattice Magic', link: '/addons/lattice_magic'}, { text: 'Lighting Overrider', link: '/addons/lighting_overrider'}, { text: 'Pose Shape Keys', link: '/addons/pose_shape_keys'}, { text: 'Render Review', link: '/addons/render_review'}, diff --git a/docs/addons/lattice_magic.md b/docs/addons/lattice_magic.md new file mode 100644 index 00000000..503172a5 --- /dev/null +++ b/docs/addons/lattice_magic.md @@ -0,0 +1 @@ + diff --git a/scripts-blender/addons/lattice_magic/docs/camera_lattice.gif b/docs/media/addons/lattice_magic/camera_lattice.gif similarity index 100% rename from scripts-blender/addons/lattice_magic/docs/camera_lattice.gif rename to docs/media/addons/lattice_magic/camera_lattice.gif diff --git a/scripts-blender/addons/lattice_magic/docs/lattice_magic.png b/docs/media/addons/lattice_magic/lattice_magic.png similarity index 100% rename from scripts-blender/addons/lattice_magic/docs/lattice_magic.png rename to docs/media/addons/lattice_magic/lattice_magic.png diff --git a/scripts-blender/addons/lattice_magic/docs/tweak_lattice.gif b/docs/media/addons/lattice_magic/tweak_lattice.gif similarity index 100% rename from scripts-blender/addons/lattice_magic/docs/tweak_lattice.gif rename to docs/media/addons/lattice_magic/tweak_lattice.gif diff --git a/scripts-blender/README.md b/scripts-blender/README.md index 3f6ceb5a..53fe3512 100644 --- a/scripts-blender/README.md +++ b/scripts-blender/README.md @@ -68,6 +68,11 @@ Add-on that can convert annotations to grease pencil objects and vise versa. Author: Paul Golter +## Lattice Magic + +This addon adds some Lattice-based utilities to Blender. + +Author & Maintainer: Demeter Dzadik ## Lighting Overrider diff --git a/scripts-blender/addons/lattice_magic/README.md b/scripts-blender/addons/lattice_magic/README.md index d18d2bfe..6bb74b0e 100644 --- a/scripts-blender/addons/lattice_magic/README.md +++ b/scripts-blender/addons/lattice_magic/README.md @@ -1,15 +1,34 @@ +# Lattice Magic This addon adds some Lattice-based utilities to Blender. -Install like any other Blender addon: Download this repository as a .zip archive, then in Blender go to Edit->Preferences->Addons->Install Addon from File, and browse the zip you downloaded, and enable the checkbox for the addon. +![Lattice Magic UI](/media/addons/lattice_magic/lattice_magic.png) -After that, you can find the Lattice Magic panel in the 3D Viewport's Sidebar, which you can bring up by pressing the N key. +## Table of Contents -![](docs/lattice_magic.png) +- [Installation](#installation) +- [Tweak Lattice](#tweak-lattice) + - [Parenting](#parenting) + - [Deletion](#deletion) + - [Adding/Removing meshes](#addingremoving-meshes) + - [Going under the hood](#going-under-the-hood) +- [Camera Lattice](#camera-lattice) + - [Creation](#creation) + - [Parenting](#parenting-1) + - [Animation](#animation) + - [Deletion](#deletion-1) -# Tweak Lattice + +### Installation +1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git` +2. From the root of the repository navigate to `/scripts-blender/addons/` +3. Find the the `lattice_magic` folder. Place this folder in your Blender addons directory or create a symlink to it. +4. After that, you can find the Lattice Magic panel in the 3D Viewport's Sidebar, which you can bring up by pressing the N key. + + +## Tweak Lattice Tweak Lattice lets you create a lattice setup at the 3D cursor to make deformation adjustments to the selected objects. -![](docs/tweak_lattice.gif) +![How to Tweak Lattice](/media/addons/lattice_magic/tweak_lattice.gif) ### Parenting This is meant to be possible to be used in conjunction with a character rig: Before pressing the "Create Tweak Lattice" button, simply select the desired parent rig object and bone in the UI. @@ -26,10 +45,10 @@ If you want more meshes to be influenced by a lattice, you don't need to delete With the lattice control selected, you can see a "Helper Objects" section in the UI. This lists two objects which are taking care of things under the hood. If you want, you can enable them with the screen icon, which will let you mess with them. This should rarely be necessary though, and you should only do it at your own risk, since there's no way to get these back to their original states once modified. -# Camera Lattice +## Camera Lattice Camera Lattice lets you create a lattice in a camera's view frame and deform a character (or any collection) with the lattice. -![](docs/camera_lattice.gif) +![Camera Lattice Demo](/media/addons/lattice_magic/camera_lattice.gif) ### Creation Add an entry to the Camera Lattice list with the + icon. Each entry corresponds to deforming a single collection with a single lattice object from the perspective of a single camera.