Merge pull request #671 from PeridexisErrant/points.lua-and-readme

Add points.lua and update readme

NEWS

@@ -24,6 +24,7 @@ DFHack Future
         fix-ster:  changes fertility/sterility of animals or dwarves
         view-item-info:  adds information and customisable descriptions to item viewscreens
         warn-starving:  check for starving, thirsty, or very drowsy units and pause with warning if any are found
+        points:  set number of points available at embark screen
     New tweaks
         kitchen-keys: Fixes DF kitchen meal keybindings
         kitchen-prefs-color: Changes color of enabled items to green in kitchen preferences
@@ -74,6 +75,7 @@ DFHack Future
         memview: Fixed display issue
         nyan: Can now be stopped with dfhack-run
         quicksave: Restricted to fortress mode
+        README: documented show/hide command, startdwarf.rb
         remotefortressreader: Exposes more information
         search:
           - Supports noble suggestion screen (e.g. suggesting a baron)

Readme.rst

@@ -291,6 +291,11 @@ control of the game.
 * Activate with 'forcepause 1'
 * Deactivate with 'forcepause 0'
 
+hide / show
+-----------
+Hides or shows the DFHack terminal window, respectively.  To use ``show``, use
+the in-game console (default keybinding Ctrl-Shift-P).  Only available on Windows.
+
 nopause
 -------
 Disables pausing (both manual and automatic) with the exception of pause forced
@@ -2589,6 +2594,12 @@ Example::
 
     multicmd locate-ore iron ; digv
 
+points
+======
+Sets available points at the embark screen to the specified number.  Eg.
+``points 1000000`` would allow you to buy everything, or ``points 0`` would
+make life quite difficult.
+
 position
 ========
 Reports the current time:  date, clock time, month, and season.  Also reports
@@ -2670,6 +2681,13 @@ Other options available: ``del``, ``clear``, ``list``.
 
 This plugin also shortens the 'sleeping' and 'on break' periods of targets.
 
+startdwarf
+==========
+Use at the embark screen to embark with the specified number of dwarves.  Eg.
+``startdwarf 500`` would lead to a severe food shortage and FPS issues, while
+``startdwarf 10`` would just allow a few more warm bodies to dig in.
+The number must be 7 or greater.
+
 stripcaged
 ==========
 For dumping items inside cages. Will mark selected items for dumping, then

scripts/points.lua

@@ -0,0 +1,3 @@
+-- by Meph
+-- http://www.bay12forums.com/smf/index.php?topic=135506.msg4925005#msg4925005
+df.global.world.worldgen.worldgen_parms.embark_points=tonumber(...)