Mystic Utilities (MUTIL)
Scripting Custom Modules
Mystic Utilities (MUTIL)
Scripting Custom Modules
I HAVE MOVED THE OLD STUFF TO THE PLAYGROUND BECAUSE THE EMBEDDED TABLES ARE TOO HARD TO EDIT IT ALSO DOES NOT EXPORT WELL TO OTHER FORMATS. I'LL BE REFORMATTING AND CHECKING FOR ACCURACY -g00
Mystic BBS has a completely configurable and incredibly flexible menu system that allows for full control over the visual appearance and functionality of the BBS. Each menu consists of the basic settings, and a list of menu commands that define what options are available on each menu. These menu commands can then be assigned one or many “actions” to perform when the item is selected. Each action may also have parameters that can be or will be required to be specified in the “data” field.
This section contains a reference to all of the menu actions available in your Mystic BBS as well as any information needed that relates to those actions.
An Auto signature is an user created signature that can optionally be automatically appended to each message posted by the user. The following menu commands are available for manipulating the auto message:
AD - Delete Auto Signature
Data: None Description: Deletes the user's auto signature
AE - Edit Auto Signature
Data: None Description: Edits the user's auto auto signature
AT - Toggle Auto Signature
Data: /NOASK Description: Asks the user if the want to enable or disable the auto signature. If the /NOASK option is supplied on the optional data field, then Mystic will toggle the setting without prompting with a Yes/No question.
AV - View Auto Signature
Data: None Description: View the user's auto signature
Mystic can have any number of different BBS lists, identified by using a “List ID”. The List ID is simply the base filename used to store the BBS list database on disk, so it can be any valid filename but should never include any file extension, just a basic word of text. The following section contains BBS List menu commands:
BA - Add new entry to BBS list
Data: <LIST ID> Description: This option allows the user to add a new entry to a BBS list. The BBS list must be specified using the <LIST ID> in the optional data.
BL - List entries in a BBS list (detailed view)
Data: <LIST ID>;SEARCH Description: This option allows the user view the BBS list using the detailed list mode. This provides more information than the typical abbreviated list The <LIST ID> must be specified in the optional data. If ";SEARCH" is appended onto the List ID, then Mystic will prompt and allow the user to search for entries in the BBS list.
BS - List entries in a BBS list (abbreviated view)
Data: <LIST ID>;SEARCH Description: This option allows the user view the BBS list using the abbreviated view mode. This provides more information than the typical abbreviated list The <LIST ID> must be specified in the optional data. If ";SEARCH" is appended onto the List ID, then Mystic will prompt and allow the user to search for entries in the BBS list.
Mystic BBS supports DOOR.SYS, CHAIN.TXT, and DORINFO1.DEF DOS-based door formats, as well as Mystic's own native DOOR32.SYS format for modern BBS doors and games. These drop files are always created in the node's specific temporary directory. For example, if a door is executed on node 1, then the drop files will be created in the temp1 temporary directory.
In the Linux and OS X versions, Mystic automatically redirects the standard input and output of external programs, allowing many programs that are not even designed for BBSes to be used.
Each door action has a command line which will be executed by the operating system when the action is executed. There are a number of codes that Mystic will replace with specific values if they are found in the command line:
%0 = The current communication handle (socket handle) %1 = Depreciated. Always returns a "1" now %2 = Depreciated. Always returns "38400" now %3 = The current node number %4 = User's IP address %5 = User's hostname %# = User's unique ID %T = User's time left in minutes %P = The node's temp directory %U = User's handle (spaces are replaced with an underscore _)
The following commands are available for executing external programs and doors:
DD - Execute External Program
Data: <command line to execute> /DOS Description: Creates the DORINFO1.DEF, CHAIN.TXT, and DOOR.SYS drop files in the node's temporary directory. In case sensitive file systems, these files are created with full UPPERCASED letters. If the /DOS option is appended on to the end of the command line, Mystic will create the drop files in a DOS text file format, even when used in operating systems like OS X and Linux that used a different text file format.
D3 - Execute DOOR32 Door Program
Data: <command line to execute> /DOS Description: Creates the DOOR32.SYS drop file in the node's temporary directory. This file is always created in lower cased letters on all operating systems. If the /DOS option is appended on to the end of the command line, Mystic will create the drop files in a DOS text file format, even when used in operating systems like OS X and Linux that used a different text file format.
Mystic supports an unlimited number of file bases and file groups which can contain any number of files within them. Files can be listed using arrow and page keys to scroll through the list, and archives can be interactively browsed and searched in the same way (including archives within archives). Mystic fully supports long file names in both file directories and file names, and has extended support for things like ANSI within .DIZ files, and more.
This section contains menu actions that are relative to Mystic's file areas.
FA - Change File Base
Data: "+", "-", <Base ID>, /NOLIST, or None Description: This action will list the File Bases in the user's current File Group and prompt the user to select a new File Base. If /NOLIST is supplied in data, then Mystic will prompt for the File Base and not automatically list them first. If the data is set to "+" then Mystic will move to the next File Base that the user has access to. If the data is set to "-" then Mystic will move to the previous File Base. Finally, the Base ID can be supplied (as shown in the File Base Editor) to automatically change the user into a specific File Base.
FD - Download Files
Data: None Description: This command will prompt the user to download file(s). If the user currently has files queued for download, Mystic will ask them first if they would like to download the queued files. If the user selects no or does not have any files in the queue, Mystic will ask them for a filename to download, and then search the File Bases to allow the user to download the requested file.
FF - Download New/Master File List
Data: /NEW, /GLOBAL, None Description: This command will compile a list of files in the File Bases based on the user's access levels. If no option is supplied, Mystic will generate a list of all files in the File Bases in the user's current file group. If /NEW is supplied, Mystic will generate a list of only new files. If /GLOBAL is supplied, Mystic will generate a list that will include all File Bases within all File Groups instead of just the current group.
FG - Change File Group
Data: "+", "-", <Group ID>, or None Description: This action will list the File Groups that the user has access to, excluding any groups flagged as "hidden" and then prompt the user to select a File Group. If the data is set to "+" then Mystic will move to the next File Group. If the data is set to "-" then Mystic will move to the previous File Group. Finally, the Group ID can be supplied (as shown in the File Group Editor) to automatically change the user into a specific File Group. When joining a file group, Mystic will display the "fgroup#" display file from the theme's text directory if it exists, where # is the group's ID.
FI - File Base Index
Data: <template filename with no extension>, or None Description: The File Base Index system presents users with a list of all File Bases, sorted by group, along with statistics of total and new files for each base. Users can scroll through and search through this list, and select File Bases to list files in as well as "subscribe" and "unsubscribe" to specific bases. The data field provides the template name which if left blank defaults to "file_index" and points to the template file to load. This field should not include a file extension as .ini will be appended to it. The template file contains all of the visual configurations for this function as well as many other options that can completely customize the experience. For example, one could copy the default file_index.ini template to file_change.ini, and then modify its visual and functional settings so that it pops up a scroll box of File Bases for the user to change their current File Base. The same could be done to pop up a list of Files Bases that allows the user to toggle which bases will be included in scans for new files. To use these alternative templates, simply execute FI with the data field of "file_change" or whatever the custom template filename you've created is.
FL - List files in current File Base
Data: SEARCH, None Description: This command will list files in the user's currently selected File Base. If the word SEARCH is in the data field, Mystic will prompt the user to enter a file mask to search for files which match a certain file mask.
FN - Scan for, and list new files
Data: "A", "C", "G", None Description: This command will scan and list new files uploaded since the last time the user scanned for new files. If no data is provided, Mystic will ask the user if they'd like to scan the current base or all bases in the user's current File Group. If data is A then Mystic will scan all File Bases within all File Groups. If data is G then Mystic will scan all File Bases in the current group without prompting. If data is C then Mystic will only scan the user's current File Base.
FP - Set new file scan date
Data: None Description: This command will allow the user to set their new last file scan date to a user inputted date. After entering the date the user will be asked if they would like to set the date for the current File Base or all File Bases. Finally, Mystic will reset the last new file scan date for appropriate Bases.
FS - Search for files
Data: None Description: This command will allow the user to search for files by performing a partial text match against the filename OR any text in the file description. Mystic will first present the "fsearch" display file if it exists, then prompt the user for search criteria. Next the user will be asked if they would like to search the current Base, all Bases in the group, or all Bases in all Groups.
FU - Upload a file
Data: None Description: This command will allow the user to upload a file. If the BBS is configured to place uploads in a specific File Base, then the file will be uploaded into that base. Otherwise, it will be uploaded to the user's currently selected File Base. Mystic will first display the "upload" display file if it exists, and next ask the user for the file transfer protocol unless the user has selected a Default protocol in which case it will skip this step. Finally, Mystic will prompt to press enter to begin the transfer. If the transfer protocol is anything that was created within the last 25 years or so, chances are Mystic will never even need to ask for filenames. In fact, a user can upload as many files as they want at one time without ever entering any file names or information about the file! Mystic can detect all of the upload files, test them, import descriptions if they exist, and optionally prompt the user for descriptions if it is configured to do so (and there wasn't a .DIZ to import). In the event a protocol is chosen from the stoneage, like Xmodem, then Mystic will simply ask for the filename before beginning the transfer.
FV - View contents of a file
Data: None Description: This command allows the user to view the contents of a file in the File Bases. The user is prompted for a file name, and the filename is then searched for throughout all Bases in the user's current file group. If a file is found, the contents will be listed and the user can navigate through its contents, view and download files within the archive, as well as view, search and download contents of archives contained with that archive.
FZ - Toggle File Bases for New Scan
Data: /ALLGROUP, None Description: This command allows users to select the bases that are included in their scan for new files during a new file scan. The bases listed are the bases in their current group. If the /ALLGROUP option is in the data field then Mystic will present them all File Bases in all File Groups as long as they meet access requirements.