diff --git a/NEWS.rst b/NEWS.rst index 25cbb7970..ae37d9e90 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -4,11 +4,27 @@ Items within each section are listed in alphabetical order to minimise merge conflicts. Try to match the style and level of detail of the other entries. + Sections for each release are added as required, and consist solely of the + following in order as subheadings:: + + Internals + Lua + New [Internal Commands | Plugins | Scripts | Tweaks] + Fixes + Misc Improvements + Removed + + When referring to a script, plugin, or command, use backticks (```) to + create a link to the relevant documentation - and check that the docs are + still up to date! + + ######### Changelog ######### .. contents:: + :depth: 1 DFHack Future @@ -138,65 +154,81 @@ DFHack Future DFHack 0.40.24-r3 ================= -:: - Internals - Ruby library now included on OS X - ruby scripts should work on OS X 10.10 - libstdc++ should work with older versions of OS X - Added support for onLoadMap/onUnloadMap.init scripts - game type detection functions are now available in the World module - The DFHACK_LOG_MEM_RANGES environment variable can be used to log information to stderr.log on OS X - Fixed adventure mode menu names - Fixed command usage information for some commands - Lua - Lua scripts will only be reloaded if necessary - Added a df2console() wrapper, useful for printing DF (CP437-encoded) text to the console in a portable way - Added a strerror() wrapper - New internal commands - hide/show: hide and show the console on Windows - sc-script: Allows additional scripts to be run when certain events occur (similar to onLoad*.init scripts) - New plugins - autohauler: A hauling-only version of autolabor - New scripts - modtools/reaction-product-trigger: triggers callbacks when products are produced (contrast with when reactions complete) - New tweaks - fps-min: Fixes the in-game minimum FPS setting - shift-8-scroll: Gives Shift+8 (or *) priority when scrolling menus, instead of scrolling the map - tradereq-pet-gender: Displays pet genders on the trade request screen - New features - autolabor: A negative pool size can be specified to use the most unskilled dwarves - catsplosion: Works on any specified races - exportlegends: Now exports more information - Fixes - Fixed game type detection in: - 3dveins - createitem - reveal - seedwatch - Made PRELOAD_LIB more extensible on Linux - add-spatter, eventful: Fixed crash on world load - building-hacks: made buildings produce/consume correct amount of power - Gave add-thought a proper subthought arg. - fix-armory compiles and is available again (albeit with issues) - gui/gm-editor: Added search option (accessible with "s") - hack-wish: Made items stack properly. - modtools/skill-change: made level granularity work properly. - show-unit-syndromes should work - stockflow: Fixed error message in Arena mode - stockflow: No longer checks the DF version - stockflow: Fixed ballistic arrow head orders - stockflow: Now convinces the bookkeeper to update records more often - zone: Stopped crash when scrolling cage owner list - Misc Improvements - building-hacks: Added a way to allow building to work even if it consumes more power - than is available. Added setPower/getPower functions. - catsplosion: Can now trigger pregnancies in (most) other creatures - exportlegends: 'info' and 'all' exports legends_plus xml with more data for legends utilities - manipulator: - Added ability to edit nicknames/profession names - Added "Job" as a View Type, in addition to "Profession" and "Squad" - Custom profession templates, with masking - remotefortressreader: Exposes more information +Internals +--------- +- Ruby library now included on OSX - ruby scripts should work on OSX 10.10 +- libstdc++ should work with older versions of OS X +- Added support for ``onLoadMap.init``/``onUnloadMap.init`` scripts +- game type detection functions are now available in the World module +- The DFHACK_LOG_MEM_RANGES environment variable can be used to log information to ``stderr.log`` on OS X +- Fixed adventure mode menu names +- Fixed command usage information for some commands + +Lua +--- +- Lua scripts will only be reloaded if necessary +- Added a ``df2console()`` wrapper, useful for printing DF (CP437-encoded) text to the console in a portable way +- Added a ``strerror()`` wrapper + +New Internal Commands +--------------------- +- `hide, show`: hide and show the console on Windows +- sc-script: Allows additional scripts to be run when certain events occur (similar to onLoad*.init scripts) + +New Plugins +----------- +- `autohauler`: A hauling-only version of autolabor + +New Scripts +----------- +- `modtools/reaction-product-trigger`: triggers callbacks when products are produced (contrast with when reactions complete) + +New Tweaks +---------- +- `fps-min `: Fixes the in-game minimum FPS setting +- `shift-8-scroll `: Gives Shift+8 (or ``*``) priority when scrolling menus, instead of scrolling the map +- `tradereq-pet-gender `: Displays pet genders on the trade request screen + +Fixes +----- +- Fixed game type detection in `3dveins`, `gui/create-item`, `reveal`, `seedwatch` +- PRELOAD_LIB: More extensible on Linux +- `add-spatter`, `eventful`: Fixed crash on world load +- `add-thought`: Now has a proper subthought arg. +- `building-hacks`: Made buildings produce/consume correct amount of power +- `fix-armory`: compiles and is available again (albeit with issues) +- `gui/gm-editor`: Added search option (accessible with "s") +- `hack-wish `: Made items stack properly. +- `modtools/skill-change`: Made level granularity work properly. +- `show-unit-syndromes`: should work +- `stockflow`: + + - Fixed error message in Arena mode + - no longer checks the DF version + - fixed ballistic arrow head orders + - convinces the bookkeeper to update records more often' + +- `zone`: Stopped crash when scrolling cage owner list + +Misc Improvements +----------------- +- `autolabor`: A negative pool size can be specified to use the most unskilled dwarves +- `building-hacks`: + + - Added a way to allow building to work even if it consumes more power than is available. + - Added setPower/getPower functions. + +- `catsplosion`: Can now trigger pregnancies in (most) other creatures +- `exportlegends`: ``info`` and ``all`` options export ``legends_plus.xml`` with more data for legends utilities +- `manipulator`: + + - Added ability to edit nicknames/profession names + - added "Job" as a View Type, in addition to "Profession" and "Squad" + - added custom profession templates with masking + +- `remotefortressreader`: Exposes more information + DFHack 0.40.24-r2 ================= diff --git a/docs/Core.rst b/docs/Core.rst index d8e50431e..6b9610afc 100644 --- a/docs/Core.rst +++ b/docs/Core.rst @@ -294,6 +294,8 @@ forcepause Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game. Activate with ``forcepause 1``; deactivate with ``forcepause 0``. +.. _`hide, show`: + hide / show ----------- Hides or shows the DFHack terminal window, respectively. To use ``show``, use diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 0cee9a9dc..bb1a27b96 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -3247,6 +3247,8 @@ sort Does not export any native functions as of now. Instead, it calls lua code to perform the actual ordering of list items. +.. _eventful: + Eventful ======== @@ -3403,6 +3405,8 @@ Integrated tannery:: b=require "plugins.eventful" b.addReactionToShop("TAN_A_HIDE","LEATHERWORKS") +.. _building-hacks: + Building-hacks ============== diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 628006db3..73128c081 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -63,6 +63,12 @@ Options (If only region and name are given, export all): Goes very well with `fortplan`, for re-importing. +.. _remotefortressreader: + +remotefortressreader +==================== +An in-development plugin for realtime fortress visualisation. + Map inspection ============== @@ -348,6 +354,8 @@ UI Upgrades When that is not appropriate because they merely add keybinding hints to existing DF screens, they deliberately use red instead of green for the key. +.. _manipulator: + manipulator =========== An in-game equivalent to the popular program Dwarf Therapist. @@ -966,6 +974,8 @@ Examples: ``autolabor CUTWOOD disable`` Turn off autolabor for wood cutting. +.. _autohauler: + autohauler ---------- Rather than the all-of-the-above means of autolabor, autohauler will instead @@ -1030,6 +1040,8 @@ Duplicate the selected job in a workshop: * In 'q' mode, when a job is highlighted within a workshop or furnace building, instantly duplicates the job. +.. _stockflow: + stockflow --------- Allows the fortress bookkeeper to queue jobs through the manager, @@ -1332,6 +1344,8 @@ workNow ------- Force all dwarves to look for a job immediately, or as soon as the game is unpaused. +.. _seedwatch: + seedwatch --------- Watches the numbers of seeds available and enables/disables seed and plant cooking. @@ -1666,6 +1680,8 @@ A package of different adventure mode tools. Usage: Map modification ================ +.. _3dveins: + 3dveins ======= Removes all existing veins from the map and generates new ones using @@ -2091,6 +2107,8 @@ or 'snow', with those words as commands (eg ``weather rain``). Mods and Cheating ================= +.. _catsplosion: + catsplosion =========== Makes cats just *multiply*. It is not a good idea to run this more than once or @@ -2379,6 +2397,8 @@ can easily result in inconsistent state once this plugin is available again. The effects may be as weird as negative power being generated. +.. _add-spatter: + add-spatter ----------- This plugin makes reactions with names starting with ``SPATTER_ADD_`` diff --git a/docs/Scripts.rst b/docs/Scripts.rst index 7cec3911d..2bc2266e1 100644 --- a/docs/Scripts.rst +++ b/docs/Scripts.rst @@ -221,6 +221,8 @@ gui/dfstatus Show a quick overview of critical stock quantities, including food, drinks, wood, and various bars. Sections can be enabled/disabled/configured by editing ``dfhack-config/dfstatus.lua``. +.. _gui/gm-editor: + gui/gm-editor ============= There are three ways to open this editor: @@ -594,6 +596,8 @@ modtools/random-trigger ======================= This triggers random dfhack commands with specified probabilities. +.. _modtools/reaction-product-trigger: + modtools/reaction-product-trigger ================================= This triggers dfhack commands when reaction products are produced, once per @@ -609,6 +613,8 @@ modtools/reaction-trigger-transition Scans raw files and creates a file to help modders transition from autoSyndrome to reaction-trigger. +.. _modtools/skill-change: + modtools/skill-change ===================== Sets or modifies a skill of a unit. @@ -792,6 +798,8 @@ elevate-physical As for elevate-mental, but for physical traits. High is good for soldiers, while having an ineffective hammerer can be useful too... +.. _exportlegends: + exportlegends ============= Controls legends mode to export data - especially useful to set-and-forget large @@ -1106,6 +1114,8 @@ setfps Run ``setfps `` to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :) +.. _show-unit-syndromes: + show-unit-syndromes =================== Show syndromes affecting units and the remaining and maximum duration, along