docs

USER_GUIDE.md

@@ -0,0 +1,70 @@
+# Text Texture Generator – Quick User Guide
+
+This guide keeps things short so you can start creating textures right away.
+
+---
+
+## What It Does
+
+- Adds a **Text Texture** panel to Blender (3D Viewport, Shader Editor, Properties).
+- Lets you type text, pick fonts, set colors, and position everything directly in Blender.
+- Generates image textures (and optional normal maps) that are packed into your `.blend` file.
+
+---
+
+## Requirements
+
+- Blender 4.0 or newer (Windows, macOS, Linux).
+- Pillow installs automatically with the addon. _(SVG overlays need CairoSVG – only install if you plan to use SVGs.)_
+
+---
+
+## Installation
+
+1. Open Blender → `Edit > Preferences > Add-ons`.
+2. Click **Install...**, choose the downloaded `.zip` (or extracted folder with `__init__.py`).
+3. Enable **Text Texture Generator** in the add-on list.
+4. Save preferences if you want it active next time.
+
+---
+
+## First Run Checklist
+
+1. Select an object with a material (or create a new one).
+2. Open the **Text Texture** panel (press `N` in the 3D Viewport or Shader Editor and look for the tab).
+3. Type your text in the **Main Text** field.
+4. Choose a font: use the system list or toggle **Use Custom Font** and browse to a `.ttf`/`.otf`.
+5. Set the texture size (Width & Height) and background (transparent or solid color).
+6. Click **Preview Texture** to see a quick render.
+7. Click **Generate Texture** when you’re happy. The image is created, packed, and ready in the Image Editor.
+
+---
+
+## Common Options (Plain English)
+
+- **Prepend / Append Text**: Add lines before or after your main message (good for labels or subtitles).
+- **Layout**: `Horizontal` keeps everything in one line; `Vertical` stacks each section.
+- **Anchor Grid**: Choose where the text starts (center, top left, etc.). Offset sliders fine-tune the position.
+- **Manual Position Mode**: Switch to percentage or pixel input if you need exact placement.
+- **Preview Background**: Checker, solid color, or gradient so you can see how the text will look.
+- **Save Presets**: Store your favorite settings either with the `.blend` file or in Blender’s config folder so you can reuse them later.
+- **Normal Map (Pro)**: Flip on **Generate Normal Map** to add depth—strength, blur, and invert control the look.
+
+---
+
+## Typical Workflow
+
+1. Enter and style your text.
+2. Use the preview to check spacing and colors.
+3. Generate the final texture.
+4. In the Shader Editor, click **Create Shader** to build a material with the new texture (and normal map if enabled).
+5. Apply the material to your object. Done.
+
+---
+
+## Tips
+
+- Need multiple styles fast? Duplicate the blend file or save presets before you start experimenting.
+- Keep the preview size smaller while fine-tuning; switch to full resolution for final renders.
+- SVG logos? Add them as overlay components—the addon will rasterize them when CairoSVG is installed.
+- For team projects, export presets (`Add-on Panel > Presets > Export`) so everyone can share the same look.