To become: Stonesense Docs and Changelog Update

Config.cpp

@@ -68,6 +68,10 @@ void parseConfigLine( string line )
         return;
     }
 
+    if( line.find("[CLOSEONESC") != string::npos) {
+        string result = parseStrFromLine("CLOSEONESC", line );
+        ssConfig.closeOnEsc = (result == "YES");
+    }
     if( line.find("[WIDTH") != string::npos) {
         int width = parseIntFromLine( "WIDTH", line );
         ssState.ScreenW = width;
@@ -80,17 +84,27 @@ void parseConfigLine( string line )
         string result = parseStrFromLine( "WINDOWED", line );
         ssConfig.Fullscreen = (result == "NO");
     }
-    if( line.find("[SEGMENTSIZE_XY") != string::npos) {
-        int value = parseIntFromLine( "SEGMENTSIZE_XY", line );
-        if(value < 1) {
+    if (line.find("[SEGMENTSIZE_X") != string::npos) {
+        int value = parseIntFromLine("SEGMENTSIZE_X", line);
+        if (value < 1) {
             value = DEFAULT_SIZE;
         }
-        if(value > 100) {
+        if (value > 100) {
             value = 100;
         }
         //plus 2 to allow edge readings
-        ssState.Size.x = value+2;
-        ssState.Size.y = value+2;
+        ssState.Size.x = value + 2;
+    }
+    if (line.find("[SEGMENTSIZE_Y") != string::npos) {
+        int value = parseIntFromLine("SEGMENTSIZE_Y", line);
+        if (value < 1) {
+            value = DEFAULT_SIZE;
+        }
+        if (value > 100) {
+            value = 100;
+        }
+        //plus 2 to allow edge readings
+        ssState.Size.y = value + 2;
     }
     if( line.find("[SEGMENTSIZE_Z") != string::npos) {
         int value = parseIntFromLine( "SEGMENTSIZE_Z", line );
@@ -100,6 +114,11 @@ void parseConfigLine( string line )
         ssState.Size.z = value;
     }
 
+    if (line.find("[AUTOSIZE_SEGMENT") != string::npos) {
+        string result = parseStrFromLine("AUTOSIZE_SEGMENT", line);
+        ssConfig.autosize_segment = (result == "YES");
+    }
+
     if( line.find("[ALLCREATURES") != string::npos) {
         string result = parseStrFromLine( "ALLCREATURES", line );
         ssConfig.show_all_creatures = (result == "YES");
@@ -159,10 +178,22 @@ void parseConfigLine( string line )
         string result = parseStrFromLine( "FOLLOW_DF_CURSOR", line );
         ssConfig.follow_DFcursor = (result == "YES");
     }
-    if( line.find("[SHOW_CREATURE_NAMES") != string::npos) {
-        string result = parseStrFromLine( "SHOW_CREATURE_NAMES", line );
+    if (line.find("[SHOW_CREATURE_NAMES") != string::npos) {
+        string result = parseStrFromLine("SHOW_CREATURE_NAMES", line);
         ssConfig.show_creature_names = (result == "YES");
     }
+    if (line.find("[SHOW_CREATURE_MOODS") != string::npos) {
+        string result = parseStrFromLine("SHOW_CREATURE_MOODS", line);
+        ssConfig.show_creature_moods = (result == "YES");
+    }
+    if (line.find("[SHOW_CREATURE_JOBS") != string::npos) {
+        string result = parseStrFromLine("SHOW_CREATURE_JOBS", line);
+        ssConfig.show_creature_jobs = (result == "YES");
+    }
+    if (line.find("[SHOW_CREATURE_PROFESSIONS") != string::npos) {
+        int value = parseIntFromLine("SHOW_CREATURE_PROFESSIONS", line);
+        ssConfig.show_creature_professions = value;
+    }
     if( line.find("[NAMES_USE_NICKNAME") != string::npos) {
         string result = parseStrFromLine( "NAMES_USE_NICKNAME", line );
         ssConfig.names_use_nick = (result == "YES");

Creatures.cpp

@@ -410,14 +410,15 @@ void DrawCreatureText(int drawx, int drawy, SS_Unit* creature )
             textcol = al_map_rgb(255,255,255);
         }
 
-        if (!creature->origin->name.nickname.empty() && ssConfig.names_use_nick) {
+        auto name = Units::getVisibleName(creature->origin);
+        if (!name->nickname.empty() && ssConfig.names_use_nick) {
             draw_textf_border(font, textcol, drawx, drawy-((WALLHEIGHT*ssConfig.scale)+al_get_font_line_height(font) + offsety), 0,
-                              "%s", DF2UTF(creature->origin->name.nickname).c_str());
+                              "%s", DF2UTF(name->nickname).c_str());
         }
-        else if (!creature->origin->name.first_name.empty())
+        else if (!name->first_name.empty())
         {
             char buffer[128];
-            strncpy(buffer,creature->origin->name.first_name.c_str(),127);
+            strncpy(buffer,name->first_name.c_str(), 127);
             buffer[127]=0;
             ALLEGRO_USTR* temp = bufferToUstr(buffer, 128);
             al_ustr_set_chr(temp, 0, charToUpper(al_ustr_get(temp, 0)));

GUI.cpp

@@ -1159,6 +1159,11 @@ void paintboard()
     ssTimers.frame_total = (donetime - ssTimers.prev_frame_time)*0.1 + ssTimers.frame_total*0.9;
     ssTimers.prev_frame_time = donetime;
 
+    if(ssConfig.show_announcements) {
+        al_hold_bitmap_drawing(true);
+        draw_announcements(font, ssState.ScreenW, ssState.ScreenH - 20, ALLEGRO_ALIGN_RIGHT, df::global::world->status.announcements);
+        al_hold_bitmap_drawing(false);
+    }
     if(ssConfig.show_keybinds){
         string *keyname, *actionname;
         keyname = actionname = NULL;
@@ -1182,18 +1187,19 @@ void paintboard()
 
         drawDebugCursor(segment);
 
-        draw_announcements(font, ssState.ScreenW, ssState.ScreenH - 20, ALLEGRO_ALIGN_RIGHT, df::global::world->status.announcements);
         drawAdvmodeMenuTalk(font, 5, ssState.ScreenH - 5);
 
         if(ssConfig.debug_mode) {
-            draw_textf_border(font, uiColor(1), 10, 3*al_get_font_line_height(font), 0, "Map Read Time: %.2fms", ssTimers.read_time);
-            draw_textf_border(font, uiColor(1), 10, 4*al_get_font_line_height(font), 0, "Map Beautification Time: %.2fms", ssTimers.beautify_time);
-            draw_textf_border(font, uiColor(1), 10, 5*al_get_font_line_height(font), 0, "Tile Sprite Assembly Time: %.2fms", ssTimers.assembly_time);
-            draw_textf_border(font, uiColor(1), 10, 6*al_get_font_line_height(font), 0, "DF Renderer Overlay Time: %.2fms", ssTimers.overlay_time);
-            draw_textf_border(font, uiColor(1), 10, 2*al_get_font_line_height(font), 0, "FPS: %.2f", 1000.0/ssTimers.frame_total);
-            draw_textf_border(font, uiColor(1), 10, 7*al_get_font_line_height(font), 0, "Draw: %.2fms", ssTimers.draw_time);
-            draw_textf_border(font, uiColor(1), 10, 8*al_get_font_line_height(font), 0, "D1: %i", DebugInt1);
-            draw_textf_border(font, uiColor(1), 10, 9*al_get_font_line_height(font), 0, "%i/%i/%i, %i:%i", contentLoader->currentDay+1, contentLoader->currentMonth+1, contentLoader->currentYear, contentLoader->currentHour, (contentLoader->currentTickRel*60)/50);
+            draw_textf_border(font, uiColor(1), 10, 2*al_get_font_line_height(font), 0, "Zoom: %.2f", ssConfig.zoom);
+            draw_textf_border(font, uiColor(1), 10, 3*al_get_font_line_height(font), 0, "Scale: %.8f", ssConfig.scale);
+            draw_textf_border(font, uiColor(1), 10, 4*al_get_font_line_height(font), 0, "FPS: %.2f", 1000.0/ssTimers.frame_total);
+            draw_textf_border(font, uiColor(1), 10, 5*al_get_font_line_height(font), 0, "Map Read Time: %.2fms", ssTimers.read_time);
+            draw_textf_border(font, uiColor(1), 10, 6*al_get_font_line_height(font), 0, "Map Beautification Time: %.2fms", ssTimers.beautify_time);
+            draw_textf_border(font, uiColor(1), 10, 7*al_get_font_line_height(font), 0, "Tile Sprite Assembly Time: %.2fms", ssTimers.assembly_time);
+            draw_textf_border(font, uiColor(1), 10, 8*al_get_font_line_height(font), 0, "DF Renderer Overlay Time: %.2fms", ssTimers.overlay_time);
+            draw_textf_border(font, uiColor(1), 10, 9*al_get_font_line_height(font), 0, "Draw: %.2fms", ssTimers.draw_time);
+            draw_textf_border(font, uiColor(1), 10, 10*al_get_font_line_height(font), 0, "D1: %i", DebugInt1);
+            draw_textf_border(font, uiColor(1), 10, 11*al_get_font_line_height(font), 0, "%i/%i/%i, %i:%i", contentLoader->currentDay+1, contentLoader->currentMonth+1, contentLoader->currentYear, contentLoader->currentHour, (contentLoader->currentTickRel*60)/50);
 
             drawDebugInfo(segment);
         }

Keybinds.cpp

@@ -186,6 +186,7 @@ action_name_mapper actionnamemap[] = {
     {"TOGGLE_STOCKS", action_togglestockpiles},
     {"TOGGLE_ZONES", action_togglezones},
     {"TOGGLE_OCCLUSION", action_toggleocclusion},
+    {"TOGGLE_FOG",action_togglefog},
     {"TOGGLE_CREATURE_MOODS", action_togglecreaturemood},
     {"TOGGLE_CREATURE_PROFS", action_togglecreatureprof},
     {"TOGGLE_CREATURE_JOBS", action_togglecreaturejob},
@@ -198,8 +199,12 @@ action_name_mapper actionnamemap[] = {
     {"TOGGLE_SHOW_HIDDEN_TILES", action_toggleshowhidden},
     {"TOGGLE_OSD", action_toggleosd},
     {"TOGGLE_KEYBINDS", action_togglekeybinds},
+    {"TOGGLE_ANNOUNCEMENTS", action_toggleannouncements},
+    {"TOGGLE_DEBUG", action_toggledebug},
     {"INCR_ZOOM", action_incrzoom},
     {"DECR_ZOOM", action_decrzoom},
+    {"INCR_UISCALE", action_incruiscale},
+    {"DECR_UISCALE", action_decruiscale},
     {"SCREENSHOT", action_screenshot},
     {"INCR_RELOAD_TIME", action_incrreloadtime},
     {"DECR_RELOAD_TIME", action_decrreloadtime},
@@ -219,6 +224,7 @@ action_name_mapper actionnamemap[] = {
     {"INCR_Y", action_incrY},
     {"DECR_X", action_decrX},
     {"INCR_X", action_incrX},
+
     //add extra action here!
 
     {"INVALID", action_invalid}//this is the stop condition
@@ -273,7 +279,7 @@ void parseKeymapLine( string line )
 
 bool loadKeymapFile(){
     string line;
-    ALLEGRO_PATH * p =al_create_path("stonesense/keybinds.txt");
+    ALLEGRO_PATH * p =al_create_path("dfhack-config/stonesense/keybinds.txt");
     const char * path = al_path_cstr(p,ALLEGRO_NATIVE_PATH_SEP);
     ifstream myfile (path);
     if (myfile.is_open() == false) {

UserInput.cpp

@@ -240,6 +240,11 @@ void action_toggleocclusion(uint32_t keymod)
     timeToReloadSegment = true;
 }
 
+void action_togglefog(uint32_t keymod)
+{
+    ssConfig.fogenable= !ssConfig.fogenable;
+}
+
 void action_togglecreaturemood(uint32_t keymod)
 {
     ssConfig.show_creature_moods = !ssConfig.show_creature_moods;
@@ -382,16 +387,44 @@ void action_togglekeybinds(uint32_t keymod){
     ssConfig.show_keybinds = !ssConfig.show_keybinds;
 }
 
+void action_toggleannouncements(uint32_t keymod) {
+    ssConfig.show_announcements = !ssConfig.show_announcements;
+}
+
+void action_toggledebug(uint32_t keymod)
+{
+    ssConfig.debug_mode = !ssConfig.debug_mode;
+}
+
 void action_incrzoom(uint32_t keymod)
 {
     ssConfig.zoom++;
-    ssConfig.scale = pow(2.0f, ssConfig.zoom);
+    if (ssConfig.scale <= 1) {
+        ssConfig.scale = pow(2.0f, ssConfig.zoom);
+    }
+    else {
+        ssConfig.scale++;
+    }
 }
 
 void action_decrzoom(uint32_t keymod)
 {
     ssConfig.zoom--;
+    if (ssConfig.scale <= 1) {
     ssConfig.scale = pow(2.0f, ssConfig.zoom);
+    } else {;
+    ssConfig.scale--;
+    }
+}
+
+void action_incruiscale(uint32_t keymod)
+{
+    ssConfig.fontsize++;
+}
+
+void action_decruiscale(uint32_t keymod)
+{
+    ssConfig.fontsize--;
 }
 
 void action_screenshot(uint32_t keymod)

UserInput.h

@@ -7,6 +7,7 @@ void action_toggledesignations(uint32_t keymod);
 void action_togglestockpiles(uint32_t keymod);
 void action_togglezones(uint32_t keymod);
 void action_toggleocclusion(uint32_t keymod);
+void action_togglefog(uint32_t keymod);
 void action_togglecreaturemood(uint32_t keymod);
 void action_togglecreatureprof(uint32_t keymod);
 void action_togglecreaturejob(uint32_t keymod);
@@ -24,9 +25,13 @@ void action_toggleshadehidden(uint32_t keymod);
 void action_toggleshowhidden(uint32_t keymod);
 void action_togglecreaturenames(uint32_t keymod);
 void action_toggleosd(uint32_t keymod);
+void action_toggledebug(uint32_t keymod);
 void action_togglekeybinds(uint32_t keymod);
+void action_toggleannouncements(uint32_t keymod);
 void action_incrzoom(uint32_t keymod);
 void action_decrzoom(uint32_t keymod);
+void action_incruiscale(uint32_t keymod);
+void action_decruiscale(uint32_t keymod);
 void action_screenshot(uint32_t keymod);
 void action_incrreloadtime(uint32_t keymod);
 void action_decrreloadtime(uint32_t keymod);

commonTypes.h

@@ -141,11 +141,14 @@ class dfColors
 
 struct GameConfiguration {
     bool overlay_mode;
+    bool autosize_segment;
     bool show_zones;
     bool show_stockpiles;
     bool show_designations;
     bool show_osd;
+    bool show_announcements;
     bool show_keybinds;
+    bool closeOnEsc;
     bool single_layer_view;
     bool shade_hidden_tiles;
     bool show_hidden_tiles;

configs/init.txt

@@ -2,6 +2,9 @@ Please note, these keywords are case sensitive for now.
 
 --Interface--
 
+Sets whether hitting Esc will close the window. (YES or NO)
+[CLOSEONESC:NO]
+
 Sets the width and height of the application in pixels.
 [WIDTH:800]
 [HEIGHT:600]
@@ -12,11 +15,15 @@ using WIDTH and HEIGHT for resolution. Try and use resolutions compatible
 with your drivers, or the program will still load in window mode.
 [WINDOWED:YES]
 
-These two options set how large the cube loaded from Dwarf Fortress is.
+These three options set how large the cube loaded from Dwarf Fortress is.
 Each entry expects the number of tiles to load.
-[SEGMENTSIZE_XY:70]
+[SEGMENTSIZE_X:70]
+[SEGMENTSIZE_Y:70]
 [SEGMENTSIZE_Z:4]
 
+Dynamically set SEGMENTSIZE when the window is resized.
+[AUTOSIZE_SEGMENT:NO]
+
 Change this to off to skip the intro.
 [INTRO:OFF]
 
@@ -92,8 +99,13 @@ Sets Stonesense in debug mode. Adds additional information to displays.
 Sets the debug cursor to follow the cursor from DF when it is there.
 [FOLLOW_DF_CURSOR:YES]
 
-Shows creatures names floating above their sprites. (Toggle with 'n')
-[SHOW_CREATURE_NAMES:YES]
+Shows creatures info floating above their sprites.
+[SHOW_CREATURE_NAMES:NO]
+[SHOW_CREATURE_MOODS:NO]
+[SHOW_CREATURE_JOBS:NO]
+
+Show creatures professions. (0-3, 0 is off)
+[SHOW_CREATURE_PROFESSIONS:0]
 
 Options to control how names are displayed (if SHOW_CREATURE_NAMES is set)
 [NAMES_USE_NICKNAME:YES]
@@ -131,7 +143,8 @@ and possibly quickly fill up yout hard-drive.
 
 Set the preferred renderer. Valid values are SOFTWARE, OPENGL, DIRECTX, and ANY. SOFTWARE has the highest
 compatibility, but is very slow.
-[RENDERER:ANY]
+On Windows, you should leave this on OPENGL for stability reasons.
+[RENDERER:OPENGL]
 
 --Colors--