diff --git a/NEWS.rst b/NEWS.rst index e966eda6a..53be4c149 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -197,8 +197,8 @@ Lua 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) +- `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 ----------- diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 842367283..192bbb36d 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -6,7 +6,8 @@ DFHack plugins are the commands, that are compiled with a specific version. They can provide anything from a small keybinding, to a complete overhaul of game subsystems or the entire renderer. -Most are listed here, hopefully organised in a way you will find useful. +Most commands offered by plugins are listed here, +hopefully organised in a way you will find useful. .. contents:: :depth: 4 @@ -351,11 +352,6 @@ 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. -.. _hotkeys: - -hotkeys -======= -Shows the DFHack keybindings active on the current screen. .. _manipulator: diff --git a/docs/Scripts.rst b/docs/Scripts.rst index 87eeaf666..0e6ef415c 100644 --- a/docs/Scripts.rst +++ b/docs/Scripts.rst @@ -2,20 +2,10 @@ DFHack Scripts ############## -Lua or ruby scripts placed in the ``hack/scripts/`` directory are considered for -execution as if they were native DFHack commands. They are listed at the end -of the ``ls`` command output. +Lua or ruby scripts placed in the :file:`hack/scripts/` directory +are considered for execution as if they were native DFHack commands. -Note: scripts in subdirectories of hack/scripts/ can still be called, but will -only be listed by ls if called as ``ls -a``. This is intended as a way to hide -scripts that are obscure, developer-oriented, or should be used as keybindings -or from the init file. See the page for each type for details. - -``kill-lua`` stops any currently-running Lua scripts. By default, scripts can -only be interrupted every 256 instructions. Use ``kill-lua force`` to interrupt -the next instruction. - -The following pages document all the standard DFHack scripts. +The following pages document all the scripts in the DFHack standard library. .. toctree:: :maxdepth: 2 diff --git a/index.rst b/index.rst index a93660db3..7f3e815a3 100644 --- a/index.rst +++ b/index.rst @@ -4,8 +4,15 @@ Welcome to DFHack's documentation! Introduction ============ -DFHack is a Dwarf Fortress memory access library, distributed with scripts -and plugins implementing a wide variety of useful functions and tools. +DFHack is a Dwarf Fortress memory access library, distributed with +a wide variety of useful scripts and plugins. + +The project is currently hosted at https://www.github.com/DFHack/dfhack, +and can be downloaded from `the releases page +`_. + +All new releases are announced in :forums:`the bay12 forums thread <139553>`, +which is also a good place for discussion and questions. For users, it provides a significant suite of bugfixes and interface enhancements by default, and more can be enabled. There are also many tools @@ -29,6 +36,7 @@ User Manual .. toctree:: :maxdepth: 2 + docs/Introduction docs/Core docs/Plugins docs/Scripts @@ -53,4 +61,5 @@ For Developers docs/Compile docs/Lua API library/xml/SYNTAX + library/xml/how-to-update docs/Binpatches