This plugin allows you to make spatial notes in your game while playing it. Afterwards, all annotations are imported into the editor so that you can review everything at ease.
Made for Godot 4.7.stable. Will probably work in other versions as well.
Download the repo and drop the /addons/dev_annotations/ directory into your own addons folder. Now enable the plugin and you're done. I have included a small set of demo scenes and scripts that allow you to play around with the plugin before integrating it.
When playing your game, the plugin automatically adds a hidden overlay menu. When backslash is pressed, this menu will appeear. In my demo scenes, this will unlock the mouse cursor and allows you to draw wherever you want. Holding rightclick grants you temporary control back over the camera for small adjustments.
Holding left click will let you draw a stroke. Releasing left click will prompt you to write a small bit of text to pair with your stroke. When you are done writing, you can press Enter to save the annotation, or Escape to discard it.
At the top of the screen, a small set of options will also be visible. These options influence how rays are casts for your annotation strokes. The Bodies and Areas allow you to ignore or include PhysicsBody3Ds or Area3Ds respectively.
The numbered buttons allow you to set the collision mask for the rays.
Keep in mind that strokes can only be painted on collision surfaces.
- Changing the trigger key: Open
/addons/dev_annotations/autoloads/runtime_annotations_manager.gd. At the top of this script, you will find thetoggle_keyconstant. You can change this to whatever you wish. - Customizing annotation mode behavior: Open and read
/addons/dev_annotations/demo_files/camera_controller.gd. This file is a small example of how to work with the provided signal.