diff --git a/docsrc/index.rst b/docsrc/index.rst index 99807f4a..12eaa30f 100644 --- a/docsrc/index.rst +++ b/docsrc/index.rst @@ -20,6 +20,7 @@ Porymap Documentation manual/region-map-editor manual/scripting-capabilities manual/project-files + manual/shortcuts manual/settings-and-options .. toctree:: diff --git a/docsrc/manual/shortcuts.rst b/docsrc/manual/shortcuts.rst new file mode 100644 index 00000000..1dc5e8a6 --- /dev/null +++ b/docsrc/manual/shortcuts.rst @@ -0,0 +1,85 @@ +********* +Shortcuts +********* + +Porymap has many shortcuts and it can sometimes be hard to keep track of them all. +Here is a comprehensive list of the shortcuts provided all in one place for your convenience. + +Main Window +----------- + +.. csv-table:: + :header: Toolbuttons + :widths: 20, 20 + + Pencil, ``N`` + Pointer, ``P`` + Bucket Fill, ``B`` + Eyedropper, ``E`` + Move, ``M`` + Shift, ``S`` + +.. csv-table:: + :header: Actions + :widths: 20, 20 + + Save Current Map, ``Ctrl+S`` + Save All Maps, ``Shift+Ctrl+S`` + Open Project, ``Ctrl+O`` + Undo, ``Ctrl+Z`` + Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z`` + 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`` + +.. csv-table:: + :header: Map Editing + :widths: 20, 20 + + Select Tiles From Map, 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 + Select Metatile, Rick-click in "paint" or "fill" mode + Zoom In, ``Ctrl++`` `or` ``Ctrl+=`` + Zoom Out, ``Ctrl+-`` + Reset View Scale, ``Ctrl+0`` + Show 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 + Select Event, Right-click in paint mode + Update Event Selection, `Ctrl+` click + + + +Tileset Editor +-------------- + +.. csv-table:: + :header: General, + :widths: 20, 20 + + Save, ``Ctrl+S`` + Undo, ``Ctrl+Z`` + Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z`` + + + +Region Map Editor +----------------- + +.. csv-table:: + :header: General, + :widths: 20, 20 + + Save, ``Ctrl+S`` + Undo, ``Ctrl+Z`` + Redo, ``Ctrl+Y`` `or` ``Ctrl+Shift+Z`` + +.. note:: + If using macOS, ``Ctrl`` refers to the ``Command`` key