v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Utility:Stonesense"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m
(22 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
[[File:stonesense_screen.png|thumb|right|Stonesense Screenshot]]
+
{{Quality|Superior|01:14, 29 September 2013 (UTC)}}
 +
{{uv|DF2014}}
 +
{{Infobox utility
 +
| image = File:stonesense_screen.png
 +
| misc  =
 +
* [http://www.bay12forums.com/smf/index.php?topic=106497 Bay12Forum Thread]
 +
* [https://docs.dfhack.org/en/stable/plugins/stonesense/docs/Stonesense.html Documentation]
 +
* [[Utility:Stonesense/Content_repository|Content Repository]]
 +
* [https://github.com/peterix/stonesense Github page]
 +
}}
  
−
==Stonesense==
+
'''Stonesense''' is a 3D visualizer [[utility]] for ''Dwarf Fortress'', implemented as a [[Utility:DFHack|DFHack]] plugin, that lets you view your ''Dwarf Fortress'' world in a classic isometric perspective.  
−
Stonesense is a third party visualizer, implemented as a [[Utility:DFHack|DFHack]] plugin, that lets you view your Dwarf Fortress world in a classic isometric perspective.
 
  
−
The official thread for feedback, questions, requests or bug reports is located at http://www.bay12forums.com/smf/index.php?topic=106497
+
There is an [http://www.bay12forums.com/smf/index.php?topic=106497 official thread] for feedback, questions, requests or bug reports.  There is also [http://www.bay12forums.com/smf/index.php?topic=48172.0 a thread dedicated to screenshots] taken using Stonesense. 
  
−
==Stonesense Content Repository==
+
==For Users==
−
The [[Utility:Stonesense/Content_repository|Stonesense Content Repository]] contains content packs that allow you to extend Stonesense functionality. These packs are made by members of the DF community.
 
  
−
==Modding With Stonesense==
+
Stonesense is distributed as part of [[Utility:DFHack|DFHack]], and included in the [[Utility:Lazy_Newb_Pack|Lazy Newb Pack]]. The standard function (dfhack "stonesense") opens a separate viewer window, which has read-only access to the game.  It can follow the game view, or be moved independently. 
−
The following pages give introductions and tutorials on how to create custom content for Stonesense.
 
−
* [[Utility:Stonesense/Sprites|Understanding Sprites]]
 
−
* [[Utility:Stonesense/Adding a simple building|Adding a simple building]]
 
−
* [[Utility:Stonesense/Adding Creatures|Adding Creatures]]
 
−
* [[Utility:Stonesense/Adding Vegetation|Adding Vegetation]]
 
−
* [[Utility:Stonesense/Adding Terrain|Adding Terrain]]
 
  
−
==Project Homepage / Source code==
+
As of June 2014, it is also possible to use Stonesense as a live overlay of the map in the main ''Dwarf Fortress'' window, replacing the usual 2D tiles.  The DFHack command for this is "<code>stonesense overlay</code>", but print mode must not be set to "TWBT" for this to run.  For best results, edit [segmentsize_z:2] in init.txt, and if you are unable to see the edges of the map with the overlay active, try also decreasing or increasing the [segmentsize_XY] - normal values are 50 to 80 depending on screen resolution.
−
The project homepage and Source code repository can be found at: https://github.com/peterix/stonesense
+
 
 +
{| class="wikitable collapsible collapsed" style="width:700px;"
 +
! colspan="2"| Mouse Controls
 +
|-
 +
| '''Left click'''
 +
| Move debug cursor (if available)
 +
|-
 +
| '''Scrollwheel'''
 +
| Move up and down
 +
|-
 +
| '''Right click'''
 +
| Recenter screen
 +
|-
 +
| '''Ctrl-Scroll'''
 +
| Increase/decrease Z depth shown
 +
|}
 +
{|class="wikitable collapsible collapsed"  style="width:700px;"
 +
! colspan="4"| Keyboard controls
 +
|-
 +
! colspan="2"| Movement controls
 +
! colspan="2"| View Filters
 +
|-
 +
| '''F'''
 +
| Cycle Tracking Mode
 +
| '''F2'''
 +
| Toggle OSD overlay
 +
|-
 +
| '''Enter'''
 +
| Rotate view 90 degrees
 +
| style="width: 30pt;" | '''D'''
 +
| Toggle Designations
 +
|-
 +
| '''R'''
 +
| Reload segment
 +
| '''I'''
 +
| Toggle Stocks
 +
|-
 +
| '''C'''
 +
| Chop walls
 +
| '''U'''
 +
| Toggle Zones
 +
|-
 +
| '''S'''
 +
| Toggle single layer
 +
| '''M'''
 +
| Toggle Creature Moods
 +
|-
 +
| '''. (Period)'''
 +
| Zoom in
 +
| '''P'''
 +
| Cycle Professions (off/icons/names)
 +
|-
 +
| ''', (Comma)'''
 +
| Zoom out
 +
| '''J'''
 +
| Cycle Jobs (off/icon/description)
 +
|-
 +
| '''Alt+(Arrow Key)'''
 +
| Offset view
 +
| '''N'''
 +
| Toggle Creatures Names
 +
|-
 +
| '''9'''
 +
|Decrease Z-layer
 +
| '''B'''
 +
| Toggle hidden tile transparency
 +
|-
 +
| '''0'''
 +
| Increase Z-layer
 +
| '''H'''
 +
| Toggle revealing hidden tiles (cheater! :P)
 +
|-
 +
|
 +
|
 +
| '''/'''
 +
| Toggle hotkey overlay
 +
|}
 +
These lists of key bindings are not exhaustive. The most up-to-date and complete list can be found at the [https://github.com/DFHack/stonesense/blob/master/resources/keybinds.txt Stonesense Github page]. The config file may also be edited to add additional keybindings to Stonesense.
 +
 
 +
==For modders and developers==
 +
 
 +
* If you just want to '''add existing content''': The [[Utility:Stonesense/Content_repository|Stonesense Content Repository]] contains content packs that allow you to extend Stonesense functionality. These packs are made by members of the DF community.
 +
* If you want to '''create your own content''': You can learn how to create custom content for Stonesense at [[Utility:Stonesense/Adding_Content]]
 +
* If you want to '''tweak Stonesense's source code''' : Stonesense is one of the many DFHack plugins. It comes with DFHack's source code, and if you manage to compile DFHack, then you've managed to compile Stonesense.
  
 
==Credits==
 
==Credits==
Line 25: Line 109:
 
* Dfhack library was written by peterix.
 
* Dfhack library was written by peterix.
 
* Additional Graphics and code were contributed by many many people, including (in alphabetical order):
 
* Additional Graphics and code were contributed by many many people, including (in alphabetical order):
−
* 7¢ Nickel, BatCountry, Belal, DeKaFu, Dante, Deon, dyze, Errol, fifth angel, frumpton, IDreamOfGiniCoeff, Impaler, Japa, jarathor, Jiri Petru, Lord Nightmare, McMe, Mike Mayday, Nexii Malthus, peterix, Seuss, soup, Talvara, winner, Xandrin.
+
** 7¢ Nickel, BatCountry, Belal, DeKaFu, Dante, Deon, dyze, Errol, fifth angel, frumpton, IDreamOfGiniCoeff, Impaler, Japa, jarathor, Jiri Petru, Lord Nightmare, McMe, Mike Mayday, Nexii Malthus, peterix, Seuss, soup, Talvara, winner, Xandrin.
−
(This list is not vigorously updated)
+
(This list is not rigorously updated)
−
 
 
  
 +
==Gallery==
 +
<gallery widths=200px>
 +
File:Roadtruss.jpg|Roadtruss, a tower [[megaproject]] by Crossroads Inc.
 +
File:Stonesense prev.jpg|...
 +
File:STV1.png|Example of Seuss's Tweaked Vegetation
 +
</gallery>
  
 
[[Category:Utilities]][[Category:Stonesense]]
 
[[Category:Utilities]][[Category:Stonesense]]
 +
[[ru:Stonesense]]

Revision as of 16:05, 18 January 2022

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
This utility page is about v0.47.05, an older version of DF.
Stonesense
Stonesense screen.png
Information

Stonesense is a 3D visualizer utility for Dwarf Fortress, implemented as a DFHack plugin, that lets you view your Dwarf Fortress world in a classic isometric perspective.

There is an official thread for feedback, questions, requests or bug reports. There is also a thread dedicated to screenshots taken using Stonesense.

For Users

Stonesense is distributed as part of DFHack, and included in the Lazy Newb Pack. The standard function (dfhack "stonesense") opens a separate viewer window, which has read-only access to the game. It can follow the game view, or be moved independently.

As of June 2014, it is also possible to use Stonesense as a live overlay of the map in the main Dwarf Fortress window, replacing the usual 2D tiles. The DFHack command for this is "stonesense overlay", but print mode must not be set to "TWBT" for this to run. For best results, edit [segmentsize_z:2] in init.txt, and if you are unable to see the edges of the map with the overlay active, try also decreasing or increasing the [segmentsize_XY] - normal values are 50 to 80 depending on screen resolution.

These lists of key bindings are not exhaustive. The most up-to-date and complete list can be found at the Stonesense Github page. The config file may also be edited to add additional keybindings to Stonesense.

For modders and developers

  • If you just want to add existing content: The Stonesense Content Repository contains content packs that allow you to extend Stonesense functionality. These packs are made by members of the DF community.
  • If you want to create your own content: You can learn how to create custom content for Stonesense at Utility:Stonesense/Adding_Content
  • If you want to tweak Stonesense's source code : Stonesense is one of the many DFHack plugins. It comes with DFHack's source code, and if you manage to compile DFHack, then you've managed to compile Stonesense.

Credits

  • Stonesense was written by Jonask, peterix, kaypy and Japa.
  • Lead graphic development was done by Solifuge.
  • Dfhack library was written by peterix.
  • Additional Graphics and code were contributed by many many people, including (in alphabetical order):
    • 7¢ Nickel, BatCountry, Belal, DeKaFu, Dante, Deon, dyze, Errol, fifth angel, frumpton, IDreamOfGiniCoeff, Impaler, Japa, jarathor, Jiri Petru, Lord Nightmare, McMe, Mike Mayday, Nexii Malthus, peterix, Seuss, soup, Talvara, winner, Xandrin.

(This list is not rigorously updated)

Gallery

  • Roadtruss, a tower megaproject by Crossroads Inc.

  • ...

  • Example of Seuss's Tweaked Vegetation

Retrieved from "https://dwarffortresswiki.org/index.php?title=Utility:Stonesense&oldid=261028"