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 YShade folder to <Project>/Plugins/YShade.
  4. Open the project, enable yShade - Easy Cel Dither 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/YShade/Binaries and Plugins/YShade/Intermediate before copying the new package. Never delete the project's own folders.

Create the first Cel / Halftone look

  1. Open Edit > Project Settings > Plugins > yShade - Cel / Halftone.
  2. Click Balanced, Clean Anime, or Comic Halftone.
  3. Confirm Enabled is checked.
  4. Adjust Bands, Midpoint, and Strength while viewing a lit opaque mesh.
  5. Enable Pattern for halftoning, then choose a pattern and set its scale.

The editor viewport updates immediately while Enable in Editor Viewports is enabled. Settings are saved to DefaultGame.ini and become the defaults for each supported world.

Add final-screen dithering

  1. Open Project Settings > Plugins > yShade - Screen Dithering.
  2. Click Subtle Color, Retro Pixel, or another preset.
  3. Confirm Enabled is checked.
  4. Tune Color Steps, Pixel Scale, Strength, and Weight.

Cel / Halftone and Screen Dithering are independent. Either pass can be enabled by itself.

Presets and reset

Cel presets are Balanced, Clean Anime, Comic Halftone, Ink Crosshatch, Soft Toon, and Off. Dither presets are Balanced, Subtle Color, Retro Pixel, 4-Color Handheld, Animated Grain, and Off.

Presets are editable starting points. Reset Cel Settings and Reset Dither Settings restore the full factory defaults. Preset and reset operations support Editor Undo.

Per-object pattern selection

Per-object pattern choice uses Custom Stencil:

  1. Keep Enable Stencil Patterns enabled.
  2. Enable Render CustomDepth Pass on the target mesh.
  3. Set Custom Stencil Value to PatternStencilBase + pattern index.

With the default base of 200, values 200-209 select Bayer, Round Dots, Square Dots, Lines, Crosshatch, Diagonal Lines, Concentric Circles, Triangles, Clustered Noise, and Spiral. Value 199 disables the transition pattern on that object. Other stencil values retain the global pattern.

Moving objects

Leave Stabilize Moving Objects disabled unless world-projected pattern sliding on translating objects is more distracting than temporal artifacts. This experimental option can create trails at silhouettes and newly revealed surfaces.