Skip to content

Commit

Permalink
Merge pull request #857 from myk002/myk_formatting
Browse files Browse the repository at this point in the history
fix some doc formatting
  • Loading branch information
myk002 authored Oct 8, 2023
2 parents 46f345d + ffe1347 commit 20d5414
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 18 deletions.
1 change: 1 addition & 0 deletions docs/devel/click-monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ Usage
-----

::

enable devel/click-monitor
2 changes: 1 addition & 1 deletion docs/gui/color-schemes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ gui/color-schemes

This is an in-game interface for `color-schemes`, which allows you to modify the
colors in the Dwarf Fortress interface. This script must be called from either
the title screen (shown when you first start the Dwarf Fortress game) or a
the title screen (shown when you first start the Dwarf Fortress game) or the
fortress main map screen.

Usage
Expand Down
6 changes: 4 additions & 2 deletions docs/modtools/change-build-menu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ your changes each time the world loads.
Just to be clear: You CANNOT use this script AT ALL if there is no world
loaded!

**Usage:**
Usage
-----

``enable modtools/change-build-menu``:

Expand Down Expand Up @@ -92,7 +93,8 @@ loaded!
changes you no longer want/need.


**Module Usage:**
Module Usage
------------

To use this script as a module put the following somewhere in your own script:

Expand Down
5 changes: 4 additions & 1 deletion docs/modtools/create-tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ modtools/create-tree

Spawns a tree.

Usage::
Usage
-----

::

-tree treeName
specify the tree to be created
Expand Down
7 changes: 6 additions & 1 deletion docs/modtools/create-unit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ modtools/create-unit
:summary: Create arbitrary units.
:tags: unavailable dev

Creates a unit. Usage::
Creates a unit.

Usage
-----

::

-race raceName
(obligatory)
Expand Down
6 changes: 4 additions & 2 deletions docs/modtools/extra-gamelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ modtools/extra-gamelog
This script writes extra information to the gamelog.
This is useful for tools like :forums:`Soundsense <60287>`.

Usage::
Usage
-----

::

modtools/extra-gamelog enable
modtools/extra-gamelog disable
5 changes: 4 additions & 1 deletion docs/modtools/force.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ modtools/force

This tool triggers events like megabeasts, caravans, and migrants.

Usage::
Usage
-----

::

-eventType event
specify the type of the event to trigger
Expand Down
15 changes: 8 additions & 7 deletions docs/modtools/if-entity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,19 @@ To use this script effectively it needs to be called from "raw/onload.init".
Calling this from the main dfhack.init file will do nothing, as no world has
been loaded yet.

Usage:
Usage
-----

- ``id``:
``id``
Specify the entity ID to match
- ``cmd [ commandStrs ]``:
``cmd [ commandStrs ]``
Specify the command to be run if the current entity matches the entity
given via -id

All arguments are required.

Example:
Example
-------

- Print a message if you load an elf fort, but not a dwarf, human, etc. fort::

if-entity -id "FOREST" -cmd [ lua "print('Dirty hippies.')" ]
``if-entity -id "FOREST" -cmd [ lua "print('Dirty hippies.')" ]``
Print a message if you load an elf fort, but not a dwarf, human, etc. fort.
5 changes: 4 additions & 1 deletion docs/modtools/interaction-trigger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ scanning the announcements for the correct attack verb, so the attack verb
must be specified in the interaction. It includes an option to suppress this
announcement after it finds it.

Usage::
Usage
-----

::

-clear
unregisters all triggers
Expand Down
7 changes: 6 additions & 1 deletion docs/modtools/projectile-trigger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ modtools/projectile-trigger
:summary: Run DFHack commands when projectiles hit their targets.
:tags: unavailable dev

This triggers dfhack commands when projectiles hit their targets. Usage::
This triggers dfhack commands when projectiles hit their targets.

Usage
-----

::

-clear
unregister all triggers
Expand Down
7 changes: 6 additions & 1 deletion docs/modtools/reaction-product-trigger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ modtools/reaction-product-trigger
:tags: unavailable dev

This triggers dfhack commands when reaction products are produced, once per
product. Usage::
product.

Usage
-----

::

-clear
unregister all reaction hooks
Expand Down

0 comments on commit 20d5414

Please sign in to comment.