Add smooth-movement plugin

docs/about/Authors.rst

@@ -49,6 +49,7 @@ Clayton Hughes
 Clément Vuchener        cvuchener
 Corey                   CoreyJ87
 daedsidog               daedsidog
+Dailton Filho           notliad
 Dan Amlund              danamlund
 Daniel Brooks           db48x
 David                   Nilsolm
@@ -121,6 +122,7 @@ Kurik Amudnil
 Kévin Boissonneault     KABoissonneault
 Lethosor                lethosor
 LordGolias              LordGolias
+Magnus Anderson         magnus-ISU
 Mark Nielson            pseudodragon
 Mason11987              Mason11987
 Matt Regul              mattregul
@@ -261,6 +263,7 @@ Vitaly Pronkin          pronvit                 mifki
 ViTuRaS                 ViTuRaS
 Vjek                    vjek
 Vladimir Florov         foxxelias
+wala343                 wala343
 Warmist                 warmist
 Wes Malone              wesQ3
 Will H                  TSM-EVO

docs/changelog.txt

@@ -55,6 +55,7 @@ Template for new versions:
 # Future
 
 ## New Tools
+- `smooth-movement`: smoothly animate creature, item, and vehicle movement in the fortress viewport
 - `export-world-map`: Export world map data for GIS and other external tools.
 
 ## New Features

docs/plugins/smooth-movement.rst

@@ -0,0 +1,50 @@
+smooth-movement
+===============
+
+.. dfhack-tool::
+    :summary: Smoothly animate movement in the fortress viewport.
+    :tags: fort interface
+
+This plugin makes creatures, hauled items, vehicles, and associated status
+icons glide between tiles. It only changes rendering; gameplay, simulation
+timing, and save data are unaffected.
+
+The plugin requires the SDL 2D renderer.
+
+Usage
+-----
+
+::
+
+    enable smooth-movement
+    smooth-movement
+    smooth-movement flip on|off
+    smooth-movement zlevel on|off
+
+Running ``smooth-movement`` without arguments reports the plugin status and
+current settings. Optional features are reset to their defaults whenever the
+plugin is enabled.
+
+Examples
+--------
+
+``enable smooth-movement``
+    Enable smooth movement on the main z-level.
+
+``smooth-movement flip on``
+    Horizontally flip creatures so they face their direction of travel.
+
+``smooth-movement zlevel on``
+    Also animate movement on visible z-levels below the main level.
+
+Settings
+--------
+
+``flip`` (default: off)
+    Flip creature sprites horizontally according to their last horizontal
+    movement. Items, vehicles, and designation icons keep their normal
+    orientation.
+
+``zlevel`` (default: off)
+    Animate movement on visible lower z-levels. Sprite flipping remains
+    independent of this setting.

plugins/CMakeLists.txt

@@ -122,6 +122,7 @@ if(BUILD_SUPPORTED)
     #dfhack_plugin(siege-engine siege-engine.cpp LINK_LIBRARIES lua)
     dfhack_plugin(sort sort.cpp LINK_LIBRARIES lua)
     #dfhack_plugin(steam-engine steam-engine.cpp)
+    add_subdirectory(smooth-movement)
     dfhack_plugin(spectate spectate.cpp LINK_LIBRARIES lua)
     #dfhack_plugin(stockflow stockflow.cpp LINK_LIBRARIES lua)
     add_subdirectory(stockpiles)

plugins/smooth-movement/CMakeLists.txt

@@ -0,0 +1,3 @@
+dfhack_plugin(smooth-movement smooth-movement.cpp LINK_LIBRARIES lua)
+target_include_directories(smooth-movement PRIVATE ${SDL2_INCLUDE_DIRS})
+dfhack_test(smooth-movement-test test_visual_animation_manager.cpp)