Yureka LogoDocs
GitHubyureka.dev

Getting Started

Install

  1. Download the package matching the project's Unreal Engine version.
  2. Close Unreal Editor.
  3. Copy the complete YShadeHandDrawn folder to <Project>/Plugins/YShadeHandDrawn.
  4. Open the project, enable yShade - Easy Hand-Drawn Shading under Edit > Plugins, and restart when prompted.
  5. If Unreal asks, rebuild the plugin or regenerate project files with the compiler supported by that engine version.

When replacing an older build, delete only Plugins/YShadeHandDrawn/Binaries and Plugins/YShadeHandDrawn/Intermediate before copying the new package.

Create the first look

  1. Open Edit > Project Settings > Plugins > yShade - Hand-Drawn.
  2. Click Storybook Ink.
  3. Confirm Enabled and Enable in Editor Viewports are checked.
  4. View a lit opaque mesh in a deferred-rendered editor viewport.
  5. Tune Style Strength, Color Levels, and Color Softness.
  6. Adjust Ink Thickness and edge thresholds.
  7. Set the shadow threshold before increasing stroke strength.
  8. Add paper grain last at the intended output resolution.

Settings update live and are saved to DefaultGame.ini as the defaults for each supported world.

Presets and reset

  • Storybook Ink: balanced painted colors, organic contours, light shadow strokes, and paper grain.
  • Soft Painted: gentle color simplification, fine translucent lines, and visible paper texture.
  • Bold Animation: clean color regions and strong contours without shadow hatching.
  • Dark Gothic: cool shadows, warm highlights, heavy ink, and crosshatched darkness.
  • Pencil Wash: desaturated paint, irregular pencil lines, scribbled shadows, and coarse paper.
  • Off: disables the pass while preserving its starting values.

Presets remain fully editable. Reset Hand-Drawn Settings restores all factory values. Preset and reset actions support Editor Undo.

Tuning workflow

Use Ink Mask, Shadow Stroke Mask, Paper Pattern, World Normals, and Scene Depth debug modes to isolate each contribution. Screen-space strokes are stable in the camera view and usually suit animated scenes. World-space strokes attach to surfaces and are often preferable for static environments.