diff --git a/NEWS.rst b/NEWS.rst index c011f6df2..1c7517adf 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -4,6 +4,11 @@ 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. + This file should not contain details specific to prereleases, but it should + contain changes from previous stable releases. For example, if a bug was + introduced in one alpha version and fixed in another, do not include it + here. + Sections for each release are added as required, and consist solely of the following in order as subheadings:: @@ -37,8 +42,10 @@ Internals --------- - 64-bit support on all platforms - Visual Studio 2015 now required on Windows instead of 2010 -- GCC 4.8 recommended on Linux and OS X (and now supported on OS X) +- GCC 4.8 or newer required on Linux and OS X (and now supported on OS X) - Several structure fixes to match 64-bit DF's memory layout +- Added ``DFHack::Job::removeJob()`` function +- Updated TinyXML from 2.5.3 to 2.6.2 Lua --- @@ -52,7 +59,6 @@ Lua Ruby ---- - Added support for loading ruby 2.x libraries -- Fixed some layouts on x64 (incomplete) New Plugins ----------- @@ -64,12 +70,18 @@ New Plugins New Scripts ----------- - `load-save`: loads a save non-interactively +- `modtools/change-build-menu`: Edit the build mode sidebar menus +- `modtools/if-entity`: Run a command if the current entity matches a given ID +- `season-palette`: Swap color palettes with the changes of the seasons Fixes ----- - The DF path on OS X can now contain spaces and ``:`` characters - Buildings::setOwner() changes now persist properly when saved +- `add-thought`: fixed support for emotion names +- `autofarm`: Made surface farms detect local biome - `devel/find-offsets`: fixed a crash when vtables used by globals aren't available +- `manipulator`: Fixed crash when selecting a profession from an empty list Misc Improvements ----------------- diff --git a/docs/NEWS-dev.rst b/docs/NEWS-dev.rst new file mode 100644 index 000000000..6a247294b --- /dev/null +++ b/docs/NEWS-dev.rst @@ -0,0 +1,101 @@ +.. comment + This is the development changelog file for DFHack. If you add or change + anything, note it here under the heading "DFHack Future", in the appropriate + section. 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. + + This file contains changes that are relevant to users of prereleases. These + changes should include changes from just the previous release, whether that + release was stable or not. For instance, a feature added in 0.43.05-alpha1 + should go under "0.43.05-alpha1" here *and* "0.43.05-r1" (or "future") in + NEWS.rst. A fix in one prerelease for an issue in the previous prerelease + should just go here in the appropriate section, not in NEWS.rst. + + Sections for each release are added as required, and consist solely of the + following in order as subheadings:: + + Fixes + Structures + API Changes + Additions/Removals + Other Changes + + 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! + + When adding a new release, change "DFHack future" to the appropriate title + before releasing, and then add a new "DFHack future" section after releasing. + +.. _dev-changelog: + +##################### +Development Changelog +##################### + +.. contents:: + :depth: 2 + +DFHack 0.43.05-alpha3 +===================== + +Fixes +----- +- `add-thought`: fixed support for emotion names +- `autofarm`: Made surface farms detect local biome +- `devel/export-dt-ini`: fixed squad_schedule_entry size +- `labormanager`: + + - Now accounts for unit attributes + - Made instrument-building jobs work (constructed instruments) + - Fixed deconstructing constructed instruments + - Fixed jobs in bowyer's shops + - Fixed trap component jobs + - Fixed multi-material construction jobs + - Fixed deconstruction of buildings containing items + - Fixed interference caused by "store item in vehicle" jobs + +- `manipulator`: Fixed crash when selecting a profession from an empty list +- `ruby`: + + - Fixed crash on Win64 due to truncated global addresses + - Fixed compilation on Win64 + - Use correct raw string length with encodings + +Structures +---------- +- Changed many ``comment`` XML attributes with version numbers to use new + ``since`` attribute instead +- ``activity_event_conflictst.sides``: named many fields +- ``building_def.build_key``: fixed size on 64-bit Linux and OS X +- ``historical_kills``: + + - ``unk_30`` -> ``killed_underground_region`` + - ``unk_40`` -> ``killed_region`` + +- ``historical_kills.killed_undead``: removed ``skeletal`` flag +- ``ui_advmode``: aligned enough so that it doesn't crash (64-bit OS X/Linux) +- ``ui_advmode.show_menu``: changed from bool to enum +- ``unit_personality.emotions.flags``: now a bitfield + +API Changes +----------- +- Added ``DFHack::Job::removeJob()`` function +- C++: Removed bitfield constructors that take an initial value. These kept + bitfields from being used in unions. Set ``bitfield.whole`` directly instead. +- Lua: ``bitfield.whole`` now returns an integer, not a decimal + +Additions/Removals +------------------ +- Removed source for treefarm plugin (wasn't built) +- Added `modtools/change-build-menu`: Edit the build mode sidebar menus +- Added `modtools/if-entity`: Run a command if the current entity matches a + given ID +- Added `season-palette`: Swap color palettes with the changes of the seasons + +Other changes +------------- +- Changed minimum GCC version to 4.8 on OS X and Linux (earlier versions + wouldn't have worked on Linux anyway) +- Updated TinyXML from 2.5.3 to 2.6.2 diff --git a/docs/Plugins.rst b/docs/Plugins.rst index ccba07973..b3e68459d 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -380,9 +380,10 @@ active in the current context. See also `hotkey-notes`. :dfhack-keybind:`hotkeys` .. _rb: +.. _ruby: -rb -== +ruby +==== Ruby language plugin, which evaluates the following arguments as a ruby string. Best used as ``:rb [string]``, for the special parsing mode. Alias ``rb_eval``. diff --git a/index.rst b/index.rst index 88d3ca6b1..1f647907b 100644 --- a/index.rst +++ b/index.rst @@ -59,6 +59,7 @@ For Developers /Contributing /docs/Compile + /docs/NEWS-dev /docs/Lua API /library/xml/SYNTAX /library/xml/how-to-update