From 30feadb4689353a0c66e62caf445f34f75f9456e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wiktor=20Obr=C4=99bski?= Date: Wed, 4 Sep 2024 19:21:31 +0200 Subject: [PATCH] Add basic documentation for notes tool --- docs/notes.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/notes.rst diff --git a/docs/notes.rst b/docs/notes.rst new file mode 100644 index 000000000..3bfc5304e --- /dev/null +++ b/docs/notes.rst @@ -0,0 +1,42 @@ +notes +===== + +.. dfhack-tool:: + :summary: Manage map-specific notes + :tags: fort interface map + +The `notes` tool enables players to annotate specific tiles +on the Dwarf Fortress game map with customizable notes. + +Each note is displayed as a green pin on the map and includes a one-line title and a detailed comment. + +It can be used to e.g.: + - marking plans for future constructions + - explaining mechanisms or traps + - noting historical events + +Usage +----- + +:: + + notes add + +Add new note in the current position of the keyboard cursor. + +Creating a Note +~~~~~~~~~~~~~~~ +1. Use the keyboard cursor to select the desired map tile where you want to place a note. +2. Execute ``notes add`` via the DFHack console. +3. In the pop-up dialog, fill in the note's title and detailed comment. +4. Press :kbd:`Alt` + :kbd:`S` to create the note. + +Editing or Deleting a Note +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- Click on the green pin representing the note directly on the map. +- A dialog will appear, offering options to edit the title or comment, or to delete the note entirely. + +Managing Notes Visibility +~~~~~~~~~~~~~~~~~~~~~~~~~ +- Access the ``DFHack Control Panel`` / ``UI Overlays`` tab. +- Toggle the ``notes.map-notes`` overlay to show or hide the notes on the map.