DM-helper

DM-helper

ver 1.8
2018 dec 6

To show the DM-helper run at the console:

`
debugmode 1
rs ui_target
debugmode 0
`

To show the Player-helper run at the console:

`
debugmode 1
rs ui_player
debugmode 0
`


to Update: delete the old "ui_TargetInfo" folder. Unzip this one to where that was.

INSTALLATION
------------
Unzip to your /Override folder.

DEINSTALLATION
--------------
Delete from your /Override folder.


MANIFEST
--------
targetinfo.XML                - the GUI for DMs or godly player-characters
playerinfo.XML                - the GUI for ungodly player-characters

ReadMe.TXT                    - this document.

ui_target.nss                - starts the DM-gui
ui_player.nss                - starts the Player-gui

gui_target_inc.nss            - #include file for the UIs
resrefs_inc.nss                - #include file for the resref-lists (player customizable)

Callbacks:

gui_target_info_update.nss    - OnUpdate from 'targetinfo.XML' that updates the DM-gui
gui_player_info_update.nss    - OnUpdate from 'playerinfo.XML' that updates the Player-gui

gui_target_operation.nss    - script that performs most of the operations of the UIs

gui_ac_adjust.nss            - changes a target's AC
gui_do_damage.nss            - does damage to a target
gui_faction_change.nss        - can change a target to one of the standard factions
gui_faction_select.nss        - can add a target to the PC-faction via the DM-gui
gui_health_bonus.nss        - grants a target an HP-bonus
gui_health_percent.nss        - sets a target's HP to a given percentage of its current HP
gui_player_ani.nss            - causes PC-party to play arbitrary animations via the Player-gui
gui_set_module.nss            - handles the output from the SetDestination inputbox
gui_set_special.nss            - handles the output from the SetSpecialResref inputbox
gui_target_ranger.nss        - determines distance; ie, the "ranger" button
gui_target_spawn.nss        - spawns a creature
gui_target_spawn_group.nss    - changes the current spawn-group

Tools:

/costpricer
it_pricer.UTI                - blueprint for the Cost Pricer item
i_it_pricer_ac.nss            - tag-based OnActivated script for the Cost Pricer

/ip_tool
ip_tool.uti                    - blueprint for the IP Tool item
i_ip_tool_ac.nss            - tag-based OnActivated script for the IP Tool


USAGE
-----
uh. The Player-UI is designed as a rather innocuous panel for players without
god-like abilities or radical spoilers (except for the Add/Boot Party button).

The DM-UI, while it can be run by standard players, is designed for DMs who
want the ability to do some weird (and quite possibly game-breaking) things. It
also has debugging tools for developers.

Several aspects of the DM-ui should have more playtesting and consequent tweaks.

use at your own risk, although I'm open to feedback also

Special:

The tabpage for spawning creatures requires custom setup. Labels for
group-buttons and lists of resrefs need to be specified before the page will
become fully enabled - see instructions in the file 'resrefs_inc'.


CAVEAT
------
The original design of this add-on was suggested and co-developed by Svelek in
the NeverwinterVault.org forums:

https://forum.neverwintervault.org/t/5-foot-grid/978

It was (and is) primarily a PnP tabletop accessory. But I couldn't resist
expanding it for my own single-player games, keeping in mind that it could be
useful for multi-player and true DMs as well.


DISCLAIMER
----------
Many of the text-fields and buttons in both UIs rely on the stock XML files
'fontfamily.XML' and 'stylesheet.XML' -- so if you are using custom font-sizes,
for example, text can disappear completely if the font-size is too large (or the
text-element size is too small). Just saying I am not a graphics person and
would rather leave the fixing of such discrepancies at your end ...