pneuma-godot/addons/Todo_Manager/README.md
2024-06-13 18:44:02 +02:00

2 KiB
Executable file

Localised READMEs

TODO Manager

example_image

Simple and flexible

  • Supports GDScript, C# and GDNative
  • Seamlessly integrated into the Godot dock
  • Lenient syntax. Write TODOs that suit your style
  • Quickly jump to lines and launch external editors

Customizable

settings_example

  • Add your own RegEx patterns
  • Set colours to your liking

Installation

Method 1 (Godot Asset Library)

The most simple way to get started using TODO Manager is to use Godot's inbuilt Asset Library to install the plugin into your project.

Step 1

Find TODO Manager in the Godot Asset Library. AssetLib image

Step 2

Install the package. You may want to untick the /doc folder at this point as it is not necessary for the functions of the plugin. Filestrcture image

Step 4

Enable the plugin in the project settings. Project image

Method 2 (GitHub)

Step 1

Click Download ZIP from the 'Code' dropdown. GitHub image

Step 2

  • Unzip the file and add it into your project folder. Make sure 'addons' is a subdirectory of res://
  • DO NOT change the name of the 'addons' or 'Todo_Manager' folders as this will break the saving and loading of your settings.

Step 3

Enable the plugin in the project settings. Project image