diff --git a/docs/plugins/follow.rst b/docs/plugins/follow.rst index a91c14f73..a0c15547e 100644 --- a/docs/plugins/follow.rst +++ b/docs/plugins/follow.rst @@ -1,5 +1,12 @@ follow ====== -Makes the game view follow the currently highlighted unit after you exit from the -current menu or cursor mode. Handy for watching dwarves running around. Deactivated -by moving the view manually. +Tags: +:dfhack-keybind:`follow` + +Make the screen follow the selected unit. Once you exit from the current menu or +cursor mode, the screen will stay centered on the unit. Handy for watching +dwarves running around. Deactivated by moving the cursor manually. + +Usage:: + + follow diff --git a/plugins/follow.cpp b/plugins/follow.cpp index e9733d5da..53ff5c523 100644 --- a/plugins/follow.cpp +++ b/plugins/follow.cpp @@ -31,11 +31,10 @@ uint8_t prevMenuWidth; DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { commands.push_back(PluginCommand( - "follow", "Make the screen follow the selected unit", - follow, Gui::view_unit_hotkey, - " Select a unit and run this plugin to make the camera follow it.\n" - " Moving the camera yourself deactivates the plugin.\n" - )); + "follow", + "Make the screen follow the selected unit.", + follow, + Gui::view_unit_hotkey)); followedUnit = 0; prevX=prevY=prevZ = -1; prevMenuWidth = 0;