Documentation.

All of the Aliases and Functions for WunderSys.

System Aliases

pp	pause toggle
unp	unpause system
sp	softpause toggle
wshow settings	Display the settings you can modify
wconfig {setting} {value}	Set a setting to a certain value
wconfig lustlist {add\|remove\|clear} {name}	Configure the lust allowlist with a name. Can add or remove a name, or clear the whole list.
wsystem restore default	Restore default settings in the system. Be careful, this deletes all saved settings.
wupdatedefaffprio	Apply updates to the wsys.return_defaultaffprios() script to your default affliction priorities.
wupdatecheck	Checks if on the current version.
whelp	Opens the Documentation page in your default browser.
wbug {bug details}	Sends me (Fendo) a message in game with a bug you have found.
dv / diag	Diagnoses afflictions.
df / def	Checks defences.
wshow defup	Set defup defences.
wshow keepup	Set keepup defences.
bdef	Def up missing defences.
reb {on\|off}	Toggles rebounding upkeep.
mass {on\|off}	Toggles mass upkeep.
keepshield {on\|off}	Toggles shield upkeep.
sl	Toggles turns lyre mode on.
slo	Toggles turns lyre mode off.
hm	Toggles health or mana priority.
br	Toggles breathing upkeep.
ret {on\|off}	Manually turn on/off retardation mode.
vivi	Toggles vivisect mode on and off.
hseed	Toggles heartseed mode on and off.
gstuff	Toggles auto picking up gold, shards, and bodies.
inra	Inrifts all riftable items in your inventory.
qq / quit	Starts the quitting procedures.

Manual Curing Aliases

cvp	Manual panick alias to try to get out of locks.
aeon	Tells the system to go into aeon mode.
wr	Manually tells serverside to writhe.
rs	Manually restores (survival ability)
dh / dheal	Manually dragonheals.
fool	Manually uses fool tarot on yourself.
c	Manually tells serverside to concentrate.
f	Manually tells serverside to focus on focus balance.
h	Manually sips health/vitality.
m	Manually sips mana/mentality.
tr	Manually tells serverside to touch tree on tree balance.
ar(a\|l\|h\|t)	Manually applies restoration to arms/legs/head/torso.
ac	Manually tells serverside to apply caloric on salve balance.
em	Manually eats moss/potash.
p(rl\|ll\|ra\|la\|t\|h)	Parry rightleg/leftleg/rightarm/ leftarm/torso/head on balance.
stand	Tells the server to assume you are prone.
blr	Queues bloodroot to eat on herb balance.
gls	Queues goldenseal to eat on herb balance.
klp	Queues kelp to eat on herb balance.
selm	Queues elm to be smoked on pipe balance.
sval	Queues valerian to be smoked on pipe balance.
sku	Queues skullcap (rebounding) to be smoked on pipe balance.

Profile Management

wshow	Displays your existing and current profiles.
wconfig profile new {profile_name}	Add a new profile. Fails if the profile name already exists.
wconfig profile delete {profile_name}	Deletes a profile.
wconfig profile copy {source_profile} {dest_profile}	Copy the settings from one profile into another
wconfig profile copyclass {source_class}	Copy the settings from one class to your current class.
wconfig profile resetaffs all{\| confirm}	Clears out all of the afflictions tied to all profiles. This helps if things get tangled up.
wconfig profile resetaffs {\w+} {\w+}	Clears out all of the afflictions tied to a profile. This helps if things get tangled up.
swp {profile_name}	Switch profiles.
defup {profile_name}	Switch profiles and raise defup defences.
Typically, you'll want to create a new profile. Configure your keepup/defup defences (wshow keepup/defup). Then move your priorities around in wshow defprio.

Do, Dofree and Dorepeat Aliases

Note: The command separator for these aliases must be / if using multiple commands. This is due to the use of Achaea's serverside aliases. HELP ALIASES can provide more information. This is NOT tied to the config command separator in Achaea.

dofree {action}	Adds something to the dofree queue. Use this only for actions that require balance+equilibrium and don't cost equilibrium+balance to use. You can chain with dofree action1/action2 like dofree g gold/put gold in pack
do {action}	Adds something to the do queue. Use this only for actions that require balance+equilibrium and cost either balance or equilibrium. You can chain with do action1/action2 like do g gold/put gold in pack/writhe if the last action is the one that costs balance/equilibrium.
dor {action}	Adds something to the dorepeat queue. Use this only for actions that require balance+equilibrium and cost either balance or equilibrium. You can chain with dor action1/action2 like dor g gold/put gold in pack/butcher buffalo if the last action is the one that costs balance/equilibrium.
dor	Clears the dorepeat queue.

Functions

Note: Wundersys uses the wsys. namespace.

Pausing

wsys.pause()	Pauses the system.
wsys.unpause()	Unpauses the system.
wsys.togglePause()	Toggles pause on and off. Used in the pp alias.
wsys.softpause()	Softpauses the system. Softpause acts like pause only that it will automatically unpause in certain situations.
wsys.unsoftpause()	UnSoftpauses the system.
wsys.toggleSoftPause()	Toggles between softpause and unsoftpause. Used in the sp alias.

Sending Commands

wsys.osend("command")	Will send a "command" (make sure it is a string) if you're not paused, softpaused, aeoned, in retardation or in lyre mode. Example: wsys.osend("dsl "..target.." curare aconite")
wsys.psend("party tell")	Will send a "party tell" (make sure it is a string) if you're not paused, softpaused, aeoned or in retardation. Example: wsys.psend(matches[2].." WEBBED!")

Status Checks

wsys.cancure()	Returns true if you're not paused, softpaused, aeoned, in retardation, lyred or asleep. Otherwise it returns false.
wsys.isslowed()	Returns true if you're aeoned or in retardation. Otherwise it returns false.
wsys.damagedarms()	Returns true if both arms are broken (lvl1, lvl2 or lvl3 break on both arms). Otherwise it returns false.
wsys.bothdamagedlegs()	Returns true if both legs are broken (lvl1, lvl2 or lvl3 break on both legs). Otherwise it returns false.
wsys.isHindered()	Returns true if both arms are broken, you're tangled (webbed, transfixed etc), impaled, paralysed or prone. Otherwise it returns false.
wsys.outriftcheck()	Returns true if you can outrift items. Otherwise it returns false.
wsys.tanglecheck()	Returns true if you're impaled, webbed, roped, tied or transfixed. Otherwise it returns false.
wsys.impaled()	Returns true if you're impaled, shadowstruck (daegger impale) or soulspeared. Otherwise it returns false.
wsys.curative_elist("item")	Returns the alchemic cure for a herbal if settings.useTransmutation is true. Otherwise it returns the herbal. For example wsys.curative_elist("kelp") would return "aurum" if wsys.settings.useTransmutation is true.
wsys.isDragon()	Returns true if you're in Dragonform. Otherwise it returns false.
wsys.isElementalLord()	Returns true if you're in Elemental Lord form. Otherwise it returns false.
wsys.isClass("class")	Returns true if you're in that "class" and not in Dragonform. Otherwise it returns false. For example wsys.isClass("monk") returns true if you're a monk and not dragonformed.
wsys.isFitnessClass()	Returns true if you're a class that can use Fitness, and not in dragonform. Otherwise it returns false.
wsys.myPing()	Returns an average of the last 10 getNetworkLatency() values. More useful for tempTimers than a simple getNetworkLatency() since that can spike up and down a little.

Do, Dofree and Dorepeat

Note: The command separator for these aliases must be / if using multiple commands. This is NOT tied to the serverside separator in Achaea.

wsys.dofreeadd("action")	Adds an action (as a string) to the dofree queue. Dofree always happens before doqueue. Only use this for abilities that require equilibrium+balance but don't cost equilibrium+balance to use. You can add up to 7 seperate actions to the queue or chain them all in one (which is better) by seperating the actions with a / in the dofreeadd. For example wsys.dofreeadd("hi/chuckle/slap " .. target)
wsys.dofreefirst("action")	The same as dofreeadd, only it will be the first thing you will do. Dofree always happens before doqueue. Only use this for abilities that require equilibrium+balance but don't cost equilibrium+balance to use. You can add up to 7 seperate actions to the queue or chain them all in one (which is better) by seperating the actions with a / in the dofreeadd. For example wsys.dofreeadd("hi/chuckle/slap " .. target)
wsys.dofreeclear()	Clears all actions from the dofreequeue table.
wsys.doclear()	Clears all actions from the dofreequeue table.
wsys.doadd("action")	Adds an action (as a string) to the do queue. Only use this for abilities that require equilibrium+balance and cost equilibrium or balance. You can chain a few commands if the first few in the chain don't cost balance/equilibrium. For example wsys.dofreeadd("g gold/put gold in pack/writhe")
wsys.dofirst("action")	The same as doadd, only it will be the first thing you will do, either on equilibrium/balance regain or at once.
wsys.doradd("action")	Sets the action chain for the dorepeat queue. Dofree and do actions will always take precedence. You can use chains here and if you use it for bashing I suggest using wsys.doradd("kill &tar") while setting the in game target to what you are bashing.
wsys.dorclear()	Clears the doreapeat action. This displays a dor cleared message.
wsys.dorclearQuiet()	Clears the doreapeat action. This will not display a message it cleared.

Defences

wsys.keepup(def, gagecho)	Sets the def (string) to defup at the preconfigured defprio (or default 25). Setting gagecho to true will gag the feedback echo.
wsys.unkeepup(def, gagecho)	Removes the def (string) from defup. Setting gagecho to true will gag the feedback echo.
wsys.togglekeepup(def)	Toggles keepup or unkeepup for a def. You can use this for selfishness in an alias like so: wsys.togglekeepup("selfishness")

Customizing Affliction Priorities

You can take a peek at the default Affliction Priorities if you look at the 'Affliction Priority Settings' script in the SETTINGS folder.

If you wish to mess about with the order I suggest moving that script outside and below the WunderSys script folder (below would be good to load after Wundersys). That way you won't lose your customized default affliction priority settings when you update Wundersys.

The script contains three functions wsys.return_defaultaffprios(), wsys.return_defaultaffpriosStackables() and wsys.return_defaultAffPrioIgnores(). Edit the priorities in wsys.return_defaultaffprios() and save the script then run the alias wupdatedefaffprio to update the priorities on the wundersys and wundersys_default curingset priorities. You can also run the function wsys.updateDefaultAffPrios() but the alias should be sufficient.

Like serverside curing the afflictions with the highest priority (1 through 25) are cured first. The first slot is left empty so that on the fly priority switching can prioritise certain afflictions in different situations. 26 will ignore an affliction or use "reset" to remove it.

Custom Prompt

The custom prompt string is saved in the settings.prompt variable. You can see the current prompt string by checking wshow display. If you click on the prompt string (which is horribly long by default) it will be pasted into your input line so you can edit it.

You can set the custom prompt by using the wconfig prompt {promptstring}. For example wconfig prompt @health @mana @willpower @endurance would show you 6007 5339 25470 22200 or something similar. If you want to add text to that you simply add it to the end of a tag, so @healthh would change that 6007 to a 6007h. @percenthealth would show 100 if at full health, @percenthealth%h would show 100%h.

There is a secondary prompt that can be configured with wconfig promptline2 {promptstring} as well or false to disable.

Prompt Tags:

More are being added over time as I work on this!

@health: current health.
@percenthealth: current health in percent.
@mana: current mana.
@percentmana: current mana in percent.
@endurance: current endurance.
@percentendurance: current endurance in percent.
@willpower: current willpower.
@precentwillpower: current willpower in percent.
@bal: shows X for balance, default prompt uses @bal@bal
@eq: shows E for equilibrium, defailt prompt uses @eq@eq
@target: echos contents of the 'target' variable.
@exits: Displays room exits short name.
@exitsfull: Displays room exits long name.
@paused: shows (PP) if paused.
@softpaused: shows (sP) if softpaused.
@phase: shows "@" if phased, blackwinded or astralformed.
@retardation: shows [RET] if in retardation mode.
@mw: shows "MW" if metawake is up.
@breathing: shows "br" if breathing is up.
@airLevel: displays pressure count from an airlord.
@timestamp: displays a timestamp.
@diffhealth: shows gain or loss of health.
@diffmana: shows gain or loss of mana.
@def: shows which defs are up. B (blindness), D (deafness), C (Cloak), K (kola), M (mass), br (breathing).
@invdef: same as the @def tag, only it shows displays the def letters if they're not deffed up.
@warning: shows the warnings (behead, breathrain etc.).
@affs: displays the prompt aff tags.
@slc: Self Limb Counter Display.
@xp: shows current % experience into the next level.
@npchp: shows current NPC health percent if targetting an NPC.
@rage: shows current battlerage.
@essence: shows current essence. (apostate and infernal)
@voice: shows current voice. (bard)
@shin: returns current shin value if shin tranced. (blademaster)
@stance: returns current stance. (bard, blademaster, or tekura monk.)
@age: shows current age. (depthswalker)
@word: shows word balance. (depthswalker)
@kai: returns current kai value if kai tranced. (monk)
@form: returns current shikudo form. (shikudo monk)
@kata: returns current kata count. (shikudo monk)
@morph: returns current morph. (druid and sentinel)
@channels: returns current channels. (magi and sylvan)
@karma: returns current karma. (occultist and unnamable)
@entity: returns current entity. (occultist)
@anathema: returns current anathema. (unnamable)
@manifestation: returns current manifestation. (unnamable)
@wrath: returns current wrath. (paladin)
@wrathbal: returns current wrath balance. (paladin)
@epitaph: returns current epitaph length. (pariah)
@devotion: returns current devotion. (priest)
@prayer: returns current prayer. (priest)
@prayerlength: returns current prayerlength. (priest)
@angelpower: returns current angelpower. (priest)
@conviction: returns current conviction. (priest)
@empower: returns current empower. (runewarden)
@venom: returns current venom. (serpent)
@spirits: returns current spirits. (shaman)
@spark: returns current spark count. (fire elemental)
@shaping: returns current shaping count. (earth elemental)

Prompt Color Tags:

#hcolour: colors something (best if you use it for the health tag of course) green if over 75% health, yellow if over 33% health and otherwise red if below 33% health
#mcolour: colors something (best if you use it for the mana tag of course) green if over 75% mana, yellow if over 50% mana and otherwise red if below 50% mana
#kaicolour: colors something (best used with the @kai tag obviously) red if below 10 kai (choke), firebrick red if below 21 kai (heal), orange if below 41 kai (cripple), yellow if below 61 kai (enfeeble), and green otherwise (can do anything)
#shincolour: colors something (best used with the @shin tag obviously) red if below 5 shin (can't infuse), firebrick red if below 15 shin (can't fist), orange if below 30 (can't blizzard), yellow if below 40 (can't annihilate) and green if above 75 (can phoenix and whatever else)
#(colour): any color you can find in mudlet as long as it has no _ in it, so SlateGrey works, but not slate_grey. Might get that working in a future update.

Custom Reporting Echoes

You can overwrite and customize the wundersys.report() function and other reporting functions under the folder INTERNALS Highlights script by copying the function(s) outside of Wundersys (place it below Wundersys) then edit how you see fit.