#CLR
Add blank lines to clear the screen ignoring any current trailing blank lines
#COLOR {pattern} fore,back,bold profile
Color last added line, comma delimited colors, supports raw jiMUD color codes, ansi word values, any valid HTML color name, of ##RRGGBB html format
#CW {pattern} fore,back,bold profile
Color all strings matching current trigger pattern, see #color for arguments
#GAG number
Gag the current or multiple lines of incoming or previous lines, if no arguments gags current line
#ECHO text
Display text to the screen and append newline
#ECHOPROMPT text
Display text to the screen
#FREEZE state
Scroll lock the display, if state is omitted it will toggle the scroll lock, if state is 0 or false it will disable scroll lock, if state is anything else it will lock the scroll back
#HIGHLIGHT pattern
make last line or line with matching pattern bold or brighter color if already bold, or makes the color brighter
#PCOL fore,back,bold XStart XEnd YStart YEnd
Color position, will assume full line if position is not supplied, if XEnd omitted will assume end of line, if xEnd -1 it will assume end of line, if YEnd omitted will assume current line, YStart and YEnd are relative to the current line, 0 current, 1 previous, ...
#PRINT text
Display text to the screen and append newline, and the display text will not fire triggers
#PRINTPROMPT text Display text to the screen, and the display text will not fire triggers
#SAY text
Display text to the screen and append newline
#SAYPROMPT text
Display text to the screen
#SHOW text
Process text as if it came from the MUD and append a new line
#SHOWPROMPT text
Process text as if it came from the MUD
#UNGAG
clear previous #gag command settings
#WRAP number
Toggle word wrap and set the wrap column to number if supplied, if number is 0 disables wrap at column
#CASE index {command 1} {command n}
return command from list based on the value of index
#IF {expression} {true-command} {false-command}
if expression is true execute true command, if false and false commands supplied execute them
#SWITCH (expression) {command} (expression) {command} ... {else command}
execute each expression until one returns true, if none are true and an else command supplied it is executed instead
Repeat commands NNN number of times
#BREAK
breaks a loop
#CONTINUE
skips to the next loop iteration
#FORALL stringlist {commands}
loop stringlist, in the format of a | delimited string and set %i as each word
#fo "first|second|third" {#sh %i}would display the words first, second, third
#LOOP range {commands}
Execute the commands a number of times given by the range. range is a min and max value separated by a comma, if max value is omitted it is assumed the single value is the max and 1 is the min value
#loop 5 {#show %i}will display numbers 1 to 5
#REPEAT expression {commands}
repeat commands number of times returned by expression
#repeat 5 %iwill display the numbers 1 to 5
#UNTIL expression {commands}
Execute commands until the expression evaluates to TRUE
#WHILE expression {commands}
Execute commands as long as expression evaluates to TRUE
Play standard System beep
#PLAYSOUND soundfile
Play a sound effect, to play local files use file://path/file.ext
#PLAYMUSIC soundfile
Play background music, to play local files use file://path/file.ext
#MUSICINFO
display currently playing background music, current position, and total length
#SOUNDINFO
display currently playing sound effect, current position, and total length
#SPEAK text
Speak text using the text to speech system
#SPEAKSTOP
Stop all speaking and clear queue
#SPEAKPAUSE
Pause speaking
#SPEAKRESUME
Resume speaking
#STOPALLSOUND
stop all sound effects and background music
#STOPSOUND
Stop the current sound effect
#STOPMUSIC
Stop the current background music
#ALIAS name|index {commands} profile
Create or alter an alias
#BUTTON name|index
Cause a button to react as if it was clicked, if index it is the position from top down starting at 0
#BUTTON name caption {commands} {icon} options2 profile
Update or create a button
#PROFILE name enable|disable
enable or disable a profile
#PROFILELIST
display a list of all profiles and current state
#UNBUTTON name|index|caption
remove a button, if index it is the position in order of buttons in profile manager
#VARIABLE name value
Set, get, or display all user set variables
#UNALIAS name profile
Delete an alias
#UNVAR name
Delete variable
#ACTION name {pattern} {commands} options1 profile
Same as #TRIGGER, see #trigger for more details
#ALARM name {time pattern} {commands} profile
Create or alter an alarm trigger
#CONDITION name|pattern {pattern} {commands} options1 profile
create a new trigger sub state, if name or pattern is omitted state will be added to last created trigger
#EVENT name {commands} options1 profile
create or update event
#FIRE text
Send text to trigger system as if received from the mud, triggering matching triggers with out displaying to screen and effecting current last line
#RAISEEVENT name arguments
fire a custom event
#raiseevent "test" 1 2 3 "4 5"will fire an event named test with arguments 1, 2, 3, and 4 5
#RAISEDELAYED amount name arguments
fire a custom event with a delay
#raisedelayed 3000 "test" 1 2 3 "4 5"will fire and event named test with arguments 1, 2, 3, and 4 5 after waiting 3 seconds
#RESUME name|pattern
enable an alarm, id arguments omitted will attempt to suspend last suspended alarm
#SET name|pattern state value profile
Set the fired state of trigger, if pattern omitted it will set the fired state of the last executed trigger, if value is omitted it will set the fired state to true, if trigger type is manual it will set the fired state then fire the trigger based on the new state, value must be 0, 1, true, or false, when fired state set to true when the trigger is executed it will be skipped and reset the fired state to default for next execution
#STATE name|pattern state profile
Set the state of trigger, if pattern and profile are omitted, state is set of the last executed trigger, if state omitted trigger state is set to 0, and fire state is set to not fired to ready fire the trigger
#SUSPEND name|pattern
disable an alarm, id arguments omitted will attempt to suspend last added alarm
#TEMP name {pattern} {commands} options1 profile
Create temporary trigger
#TRIGGER name {pattern} {commands} options1 profile
create or update trigger
#TRIGGER name options1 profile
Update options1 for a trigger
#UNACTION {name|pattern} profile
Same as #UNTRIGGER, see #UNTRIGGER for more details
#UNTRIGGER {name|pattern} profile
remove a trigger
#UNEVENT name profile
Delete an event
#ADD name value
Add value to variable named name, if current value is non numeric an error will be displayed
#ALL {commands}
Send commands to all client windows as if sent from command line
#CHAT text
Send text to chat window and append a new line
#CHATPROMPT text
same as #chat but does not append a new line
#CHARACTER
Send current character name to the mud, without echoing to the screen
#CLEARNAME name or id
Clear client current or named client's name
#CLOSE name or id
Close current tab/window or named window
#CR
Send a blank line to the mud
#COMMENT text
Does nothing, allows commenting scripts
#CONNECTTIME
display time since connected
#EVALUATE expression
Evaluate expression and display to screen like show
#GETSETTING name
display a setting value, Keys and value types
#HIDECLIENT
Hide client window
#ID
Display client id
#IDLETIME
Display time a command was last sent
#MATH name value
Set value to variable named name
#NAME name id
Set the name for the current window or for the window id If no arguments, displays current window name
#NOOP text
Does nothing, but will expand arguments
#NOTIFY title message {icon}
Display a notification popup with no sound, use client.notify to turn off silent option or #playsound
#PROMPT variable message defaultValue mask
Displays a prompt dialog to enter text and store results in variable
variableVariable name to store returned resultpromptOptional prompt message to display, if '' or null will not be displayeddefaultValueDefault value to set input value tomasktrue to use default masking or a character to use as a mask, Only the first letter is used when supplying a custom mask if more then one letter
Warning This is a blocking command and may cause the client to appear frozen until input has been returned from the dialog
#SEND file prefix suffix
Send file to mud line by line pre-pending and appending supplied prefix and suffix to each line as if sent from command input
#SEND text
Send text to mud as if sent from command line
#SENDRAW file prefix suffix
Send file to mud line by line pre-pending and appending supplied prefix and suffix to each line with out parsing or echoing to the screen
#SENDRAW text
Send raw text directly to mud with out parsing or echoing to the screen appending a newline if needed
#SENDPROMPT text
Send raw text directly to mud with out parsing or echoing to the screen with no appended newline
#SETSETTING name value
alter a setting value see: Keys and value types
#SETMAP file setCharacter
Set the map file for the current connection and open mapper with optional flag to set to character if using character manager
#SHOWCLIENT
Show client window
#TAB character or id
Create a new client tab in current window
#TO name or id {commands}
Send commands to named client or client id as if sent from command line
#TOGGLECLIENT
Toggle show and hide of client window
#WAIT amount
Pause current block for a number of milliseconds
#WINDOW name close #WINDOW name character or id
Open or show named window or create new window with name, supported names: about, prefs, mapper, editor, profiles, chat, code-editor, help, immortals, history, log-viewer, skills, who Pass close as 3rd argument will close the window if open and possible
#WINDOW new character or id name
Create a new client window using the optional character title or id If character or id argument is 0 it will create just a new window with name
Display current jiMUD version information
Test commands allow you to debug or test features of the client
#TESTLIST
List all test commands
#TESTCOLORS
Display a basic ANSI color table
#TESTCOLORSDETAILS
Display a more detailed ANSI color table
#TESTXTERM
Display an XTerm test pattern
#TESTMXP
#TESTMXP2
Test custom elements
#TESTMXPEXPIRE
Test MXP link expiring
#TESTMXPCOLORS
Display a full list of all supported MXP color names
#TESTMXPELEMENTS
Test more MXP custom elements
#TESTMXPLINES
Test MXP line tagging support
#TESTMAPPER
Test mapper by generating a test area named
Doc Build Samples Area, with 3 x 3 room square with different settings set for each room.
#TESTFANSI
Test FANSI support
#TESTURLDETECT
Test auto url detection by displaying random urls and formats
#TESTXTERMRGB
Display a more detailed XTerm color pattern
#TESTSIZE
Test the current width and height of the client in characters by repeating
wfor # of columns as line 0 and displaying the numbers 1 to height - 1
#TESTSPEED
Test the speed of the client by running the commands
#TestMXPColors,#TestMXP,#TestColors,#TestColorsDetails,#TestXTerm,#TestXTermRGB10 times taking the time it took to parse, then display. After all test have been ran it will display 0 to 9 and each time and an avg time. Note this will cause the client to become unresponsive or locked while running this test, either wait til done or close.
#TESTSPEEDFILE file
Works exactly like #testspeed but will use file argument instead of built in test functions, Note file load time can cause test to run longer then total time returned
#TESTSPEEDFILER file
Works exactly like #TestSpeedFile but will attempt to emulate as if sent from remote mud for processing
#TESTFILE file
Loads a file, displays it and time to display Note this will cause the client to become unresponsive or locked while running this test, either wait til done or close.
#TESTPERIOD
Toggle on/off a test that will alternate between #testcolors, #textxterm, #testlist every 2 seconds to simulate constant streaming of text
#TESTUNICODEEMOJI
Display emoji unicode symbols
#TESTCONTROLCHARS
Test display control codes setting for display
Note: All italic arguments are optional and can be left out
Note: All quoted arguments will be processed based on scripting quote preference when required
Explain what each argument does and if it is optional
| Argument | Optional | |
|---|---|---|
| text | Text to display or process by a command | |
| amount | The amount of milliseconds to wait, must be greater then 0 | |
| name | Sometimes | The name for an item or setting |
| index | an index of an item from 0 to max items - 1 | |
| {commands} | Commands to set for command, the {} are required and will be stripped when processed | |
| options | Yes | comma delimited list of options to set1,2 |
| profile | Yes | Which profile to search |
| value | the value to set for a command, if toggle will and boolean type it will toggle between true and false | |
| enable | Yes | send enable to command, if left off will toggle |
| disable | Yes | send disable to command, if left off will toggle |
| soundfile | A sound file from the mud or a full url to a sound file, Note: due to security checks some sites may not allow access to files from other sites. | |
| title | the text to display for title, quote text to include spaces | |
| message | the text to display as message | |
| arguments | Space delimited format grouped based on scripting quote preference | |
| number | Yes | if >= 0 it will gag current line and that number of incoming lines, if negative it will gag the # of lines before current line |
| {pattern} | Sometimes | A valid trigger pattern |
| caption | the caption to display when mouse hovers over button | |
| {icon} | Yes | a path to an image file, supports {assets} path |
1.Trigger and event options
nocrdisable trigger on newlinepromptenable trigger on promptcaseenable case sensitiveverbatimenable verbatimdisabledisable triggerenableenable triggertemporarytemporary triggercmdcommand input trigger, invalid for eventspriority=#set the priority of triggerrawraw trigger, invalid for events, invalid for eventsparams=valueparam setting for trigger types that support it, invalid for eventstype=#|valuethe trigger type, this overridescmdoption if set, invalid for events- 0 or regular - create regular expression trigger
- 1 or commandinputregular - create command in put regular expression trigger
- 2 or event - create event
- 3 or alarm - create alarm
- 8 or command - create command
- 16 or commandinputpattern - create command input pattern
- 65536 or manual - create manual type, sub triggers only
- 131072 or reparse - create reparse type, sub triggers only
- 262144 or reparsepattern - reate reparsepattern type, sub triggers only
patterncreate pattern trigger, may be used instead of type=regularcreate regular trigger, may be used instead of type=alarmcreate alarm trigger, may be used instead of type=eventcreate event, may be used instead of type=cmdpatterncreate cmmand input pattern trigger, may be used instead of type=reparsecreate reparse trigger, sub triggers only, may be used instead of type=reparsepatterncreate reparse pattern trigger, sub triggers only, may be used instead of type=manualcreate manual trigger, sub triggers only, may be used instead of type=
2.Button options
nosenddo not send to mudchainchain to end of command if nosend disabledappendappend command to end of command input if nosend is setstretchstretch icon to fill buttondisabledisable buttonenableenable buttonpriority=#set the priority of button