Update 'Shortcuts' manual page

This commit is contained in:
GriffinR
2025-05-17 02:25:59 -04:00
parent 8b437281ab
commit 8dba5c24a2
3 changed files with 28 additions and 14 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 591 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 501 KiB

View File

@@ -2,12 +2,13 @@
Shortcuts
*********
Porymap has many keyboard shortcuts set by default, and even more that can be customized yourself. You can view and customize your shortcuts by going to *Options -> Edit Shortcuts*. Shortcut actions are grouped together by the window that they are used in (Main Window, Tileset Editor...). You can set up to 2 shortcuts per action, but you cannot have duplicate shortcuts set within the same window. If you enter a shortcut that is already in use, Porymap will prompt you cancel or overwrite the old shortcut. You can also restore your shortcuts to the defaults.
Porymap has many keyboard shortcuts set by default, and even more that can be customized yourself. You can view and customize your shortcuts by going to ``Options > Edit Shortcuts``. Shortcut actions are grouped together by the window that they are used in (Main Window, Tileset Editor...). You can set up to 2 shortcuts per action, but you cannot have duplicate shortcuts set within the same window. If you enter a shortcut that is already in use, Porymap will prompt you to cancel or overwrite the old shortcut. You can also restore your shortcuts to the defaults.
.. figure:: images/shortcuts/edit-shortcuts.gif
:alt: Edit Shortcuts
.. figure:: images/shortcuts/shortcuts-editor.png
:alt: Shortcuts Editor
:align: center
Edit Shortcuts
Shortcuts Editor
Your shortcuts are stored at ``%Appdata%\pret\porymap\porymap.shortcuts.cfg`` on Windows and ``~/Library/Application\ Support/pret/porymap/porymap.shortcuts.cfg`` on macOS).
@@ -35,36 +36,31 @@ Main Window
Save Current Map, ``Ctrl+S``
Save All Maps, ``Shift+Ctrl+S``
Open Project, ``Ctrl+O``
Close Project, ``Ctrl+W``
Undo, ``Ctrl+Z``
Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z``
Back, ``Alt+←``
Forward, ``Alt+→``
Show Edit History Window, ``Ctrl+E``
Open New Map Dialog, ``Ctrl+N``
Open New Tileset Dialog, ``Ctrl+Shift+N``
Open Tileset Editor, ``Ctrl+T``
Open Region Map Editor, ``Ctrl+M``
Edit Preferences, ``Ctrl+\,``
Exit, ``Ctrl+Q``
.. csv-table::
:header: Map Editing
:widths: 20, 20
Select Metatile, Right-click in "paint" or "fill" mode
Select Multiple Metatiles, Hold Right-click while dragging
Bucket Fill Metatiles, Middle-click from "paint" or "fill" mode
Magic Fill Metatiles, ``Ctrl+`` Middle-click from "paint" or "fill" mode
Zoom In, ``Ctrl++`` `or` ``Ctrl+=``
Zoom Out, ``Ctrl+-``
Reset View Scale, ``Ctrl+0``
Toggle Grid, ``Ctrl+G``
Toggle Cursor Outline, ``C``
Toggle Player View, ``V``
Toggle Draw Smart Paths, Hold ``Shift``
Draw Straight Paths, Hold ``Ctrl``
Duplicate Event(s), ``Ctrl+D`` while selected
Delete Event(s), ``DEL`` while selected
Pointer, Right-click in "paint" mode
Select Event, Left-click in "pointer" mode or Right-click in "paint" mode
Select Multiple Events, `Ctrl+` click
@@ -78,6 +74,10 @@ Tileset Editor
Save, ``Ctrl+S``
Undo, ``Ctrl+Z``
Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z``
Copy, ``Ctrl+C``
Cut, ``Ctrl+X``
Paste, ``Ctrl+V``
Toggle Grid, ``Ctrl+G``
@@ -91,6 +91,20 @@ Region Map Editor
Save, ``Ctrl+S``
Undo, ``Ctrl+Z``
Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z``
Delete layout square, ``DEL`` `or` ``Backspace``
Resize tilemap, ``Ctrl+R``
Custom Scripts Editor
---------------------
.. csv-table::
:header: General,
:widths: 20, 20
Remove selected scripts, ``DEL`` `or` ``Backspace``
.. note::
If using macOS, ``Ctrl`` refers to the ``Command`` key
If using macOS, ``Ctrl`` refers to the ``Command`` key, and ``Alt`` refers to the ``Option`` key.