Chalk++

Banner art by Ame

🎨 Usage

• Equip any chalk to start using Chalk++.
• Press Y to bring up the overlay UI and again to cycle modes forward.
  • Press <Shift> + Y to cycle backwards.
  • Press <Ctrl> + Y to toggle Chalk++ on/off
• Press on the Chalk++ button in the overlay to select a mode.
• Press on the palette button in the overlay to select a color mask.

Masking

While masking, chalk drawn outside your chosen masking color is discarded.

• To use masking simply hold <Ctrl> while drawing with Chalk++ tools.
• Or, if you are going to be drawing for awhile, you can select and use the freehand masking mode.
• You can pick your masking color by clicking on the Chalk++ button in the UI...
  • OR, by holding <Alt> while scrolling up or down...
  • OR, <Alt> + clicking a canvas cell to set your mask to the cell's color.

Modes

1. Checkerboard (Half) dithering
2. Dotted (1/9th) dithering
3. Masking (freehand)
4. Bucket Fill
5. Line Tool
6. Symmetrical mirroring

Checkerboard (½) dithering

Brush pattern that is half-filled with your chosen color

[!TIP] Hold <Shift> while drawing to offset the grid pattern by 1x cell

Dotted (1/9th) dithering

Brush pattern of a square filled only with a single cell of your chosen color

Bucket fill

Line tool

Press and drag to show a line preview. Release to set your line.

[!TIP] You can mask while using the line tool, too! (Holding <Control>)

Symmetrical Mirroring

Tips

Quick erase

Press E (configurable in settings) to erase without equipping the eraser. Mode effects (mirror, brush patterns, etc.) will apply to the eraser pattern!

⚙️ Options

Options can be changed in-game via Settings > Mods > Chalk++,
or by editing GDWeave/configs/Toes.ChalkPlusPlus.json.

• useEraserAsChalk (default: true)
  • true: Eraser behaves identical to a “brown chalk” with Chalk++ brush features.
  • false: Use eraser normally while in any mode.
• drawingSounds (default: true)
  • Hear immersive sound effects while drawing.

• useFixedChalkTextures (default: true)
  • Restores the original RGB color palette texture to canvasses
  • Fixes a bug in the canvas tile's material/texture that causes it to normally appear over-saturated (e.g., red looks magenta)

• glowInTheDarkChalk (default: true)

  • Changes chalk to be unaffected by lighting/shadows
  • Primarily for usage with daytime lighting changing mods such as Daylight

• hideCanvasObstructions (default: true)

  • Benches and trees on canvases become invisible and intangible while using Chalk++

• alwaysHideObstructions (default: true)

  • true: Never show benches/trees on canvas
  • false: Hide canvas obstructions only when Chalk++ is active

Changelog

Contributing (PRs welcomed)

Known Issues

Feedback & Bug Reports (Discord)

Roadmap & Feature Requests

License

• All source code in this repository, except where otherwise noted, is licensed under GPL-3.
• Images, logos, and other media files are not covered by this license.
  They are © and may not be used without explicit permission