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

Changelog

v2.999.6

• Hotfixed white chalk not working. Sorry!

v2.999.5 - Alpha masking eraser QOL change, Mini canvas fix

• After switching to Eraser while freehand masking with alpha mask, the eraser will now automatically ignore your (alpha) mask and instead allow you to erase whatever chalk you were drawing with last. This will not take affect in other circumstances and you can still use eraser as chalk normally. This is meant to solve some bad UX where in order to erase a player had to set their mask to whatever needed erasing, every time, and then back to alpha masking. Consider: it doesn't ever make sense to mask an eraser using erased cells. They're already erased. But you took the eraser out for a reason surely. This patch acknowledges and addresses this situation. tl;dr: erasing while freehand masking will now be much better / less tedious
• The issues preventing using Chalk++ on the mini canvas (outside Aquarium) have been resolved (#11)

v2.999.0 - V3 pre-release

• Added support for custom chalk color mods
  • Modded chalk items should be automatically detected and used just like regular chalk items
  • This is a general compatibility not full integration, yet.
  • When using a custom color as a mask it will display as "special" due to not knowing the name (or RGB color values) of the custom color

v2.3.0

• Equip animations when switching between chalks are now instantaneous!
• Added safeguards to prevent crash when lobby closes unexpectedly or player is kicked

v2.2.1

• Fixed (long-standing) issue causing some mod settings to always default and not persist when changed

v2.2.0

• New hotkey <Ctrl> + Y: Quickly toggle on/off Chalk++

  • Useful for hopping back and forth between one mode and regular chalk drawing rather than needing to cycle around or pick from the dropdown.

• 

  • Added workaround for Calico mod compatibility
    • This is applied automatically if obstruction hiding is enabled and Calico is detected
  • Added setting for bench/tree hiding feature hideCanvasObstructions
  • Changed obstruction hiding to always hide instead of only when Chalk++ active
    • This behavior can be changed with the alwaysHideObstructions setting

v2.1 - Line tool

• New line tool! Check it out!
• New glowInTheDarkChalk feature (optional)

v2.0.0

• Overlay UI is complete

v1.7.0 - Chalk Recoloring (Optional)

Thanks to Adamantris for this feature suggestion!

v1.6.0 - UI Enhancements

• You can now pick your masking color by clicking on the Chalk++ button in the UI!
• Removed unused stale dependency BlueberryWolfiAPIs

Chalk++ now requires Socks >= v0.999.0 be sure to update that too!!

v1.5.1

• New Added an unlimited distance override for the limit at which players are were able to reach and draw on a canvas with chalk
  • You can now draw on canvasses without having to be directly on top of or touching them
• Fixed accidentally triggering eraser shortcut
• Fixed masking color scroll-selection inadvertently zooming the camera

v1.4.0 - QOL Enhancements

• Added new eraser shortcut: You can erase chalk without ever needing to equip your eraser item by pressing the E key.
  • Any mode transformations will still be respected, while erasing!
• Masking in mirror mode no longer masks the mirror - only whatever you are targeting with your chalk
• Added chalk drawing ambient sounds. You can disable these in the config options if you prefer.

v1.3.0 - Mirror Mode 🪞

• Added new mode: Symmetrical Mirroring that replicates your chalk drawings horizontally over the Y-axis!
  • Masking works for this mode and applies to both transformations being applied (This could change potentially later...)
  • We will consider adding X and/or Y symmetry toggling upon request, if we receive any feedback or requests about this.
  • We tried out X+Y symmetry and it was neat but not super useful-seeming 🤷
• While holding down <CTRL> to enable the masking utility, or using the masking tool, the UI overlay will now indicate that masking is active.

v1.2.0 - Eraser++

• Eraser now behaves by default just like a chalk. See options for more details and how to toggle this feature on/off.
• While using Chalk++, benches and trees on canvasses will be hidden.
  • If using Calico, a small config change is needed in order for this to work, for now.
• Restored warning when attempting to fill the incompatible aquarium canvas.

v1.1.0 - Fixes galore

• UI Overlay style refinement
• Fixed eraser being blocked by Chalk++
• Fixed large fills not propagating to peers (and therefore not persisting)
  • This shouldn't happen but please report if you are auto-kicked by an anti-Stamps mod for filling

v1.0.2

• Hotfixed white chalk not working

v1.0.0

• Now requires Tacklebox as a dependency to manage hotkeys (since BlueberryWolfi's APIs haven't been updated in nearly a year and are dysfunctional- not actually saving any of the player's keybind changes. Somebody should make a better Webfishing API ...🤔)
• Minor changes/fixes
• Code overhaul

v0.2.0 - UI Hotfix, Typeface change

• Hotfixed dangling UI dependency causing issues for some players
• Added cute font typeface for Chalk++ UI

v0.1.0 - UI

• Added basic UI/HUD overlay for keeping track of mode selection and mask picking

v0.0.12 - Performance and Quirk Fixes

• Now requires Socks 0.4.0 - be sure to update that!
• Fixed Alt-tabbing while drawing - will no longer continue drawing as if your mouse is still held-down (Vanilla bug)
• Performance improvements!
• Your mode, masking color, etc. now consistently reset to default between different lobbies
• Mostly unseen/internal code refactoring

v0.0.11 - No-More-Stamps Mod Circumvention/Fix

• Large canvas fills are now batched when larger than 1000 cells in order to prevent tripping Stamp-mod detection (this would be extremely rare)

v0.0.10 - Minor control enhancements

• You can now pick a masking color from a cell (<alt> clicking) while in any mode, not just masking
• If you press <shift> in combination with your cycle-mode hotkey, it will cycle backwards instead of forwards

v0.0.7 - Misc. Fixes and Cleanup

NOTE: You may need to rebind your hotkey, once!

• (FIX) Filling a blank canvas should now constrain pretty close to the canvas's circular shape rather than the entire square canvas
• Many misc. UI cleanup changes

v0.0.6 - Fill feature

• (NEW FEAT) Color filling ("Paint bucket fill")

v0.0.5 - Masking UX Improvements and fixes

• (NEW FEAT) Masking color picker: While in masking mode, hold down <ALT> and click on a canvas cell to select the color of the sell as the new masking color!
• (FIX) You should no longer make accidental chalk marks unintentionally when using your inventory screen
• (CHANGE) Masking selections should no longer reset when changing chalks