display_files
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
display_files [2016/04/04 09:15] – g00r00 | display_files [2023/01/23 14:39] – g00r00 | ||
---|---|---|---|
Line 3: | Line 3: | ||
Display files are displayed by the BBS to the user at certain times while a user is online. | Display files are displayed by the BBS to the user at certain times while a user is online. | ||
- | Some display files are displayed by certain events within the BBS, such as the user's birthday. | + | Some display files are displayed by certain events within the BBS, such as the user's birthday. |
+ | |||
+ | Every prompt shown to the user within the BBS can also be replaced with a display file, so you will find and want to use these files everywhere. | ||
=== File Extension === | === File Extension === | ||
Line 10: | Line 12: | ||
Pipe color codes can be used in .ASC files, and Mystic will filter them out just as is does anywhere else in the BBS, displaying the colors when the user has ANSI and not displaying colors when they don' | Pipe color codes can be used in .ASC files, and Mystic will filter them out just as is does anywhere else in the BBS, displaying the colors when the user has ANSI and not displaying colors when they don' | ||
+ | |||
+ | Note that all extensions are lower-cased on operating systems with case sensitive file names. | ||
+ | |||
+ | === Random Display Files === | ||
+ | |||
+ | Mystic has the capability to allow for an unlimited number of variations | ||
+ | of any display file which will be selected at random when the file is | ||
+ | displayed. | ||
+ | then any addition files with a .# after the base filename will be included | ||
+ | and selected to display at random whenever the " | ||
+ | normally display. | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | In the above example, any time the " | ||
+ | Mystic will randomly select one of the files. | ||
+ | |||
+ | === Terminal Size Specific Display Files === | ||
+ | |||
+ | Mystic allows for display file variations to be defined for custom terminal | ||
+ | sizes and it will select the most appropriate file based on the user's current | ||
+ | terminal size. For example, if the base display file name is " | ||
+ | variations can be created based on column size, line size, or both. Here is | ||
+ | an example of creating some column-based variations: | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | The line size can also be defined as well, for example: | ||
+ | |||
+ | | ||
+ | |||
+ | This system can even work side by side with the random display file system! | ||
+ | For example: | ||
+ | |||
+ | scroller.1.ans | ||
+ | scroller.2.ans | ||
+ | scroller.1.c160.ans | ||
+ | scroller.2.c160.ans | ||
+ | |||
+ | In this example Mystic would select randomly either scroller.1.c160 or | ||
+ | scroller.2.c160.ans if the user had 160+ columns, otherwise it would | ||
+ | select one of scroller.1 or scroller.2 display files whenever the | ||
+ | display file " | ||
+ | |||
+ | **//(NOTE: The column based file naming also works for all of Mystic' | ||
+ | template files as well!)//** | ||
+ | |||
+ | === Baud Rate Emulation === | ||
+ | |||
+ | Mystic allows every display file to be shown as if it were being displayed at a specific modem baud rate. This can be accomplished in a number of ways, from embedding a [[displaycodes|Display Code]] within the display file itself, to using parameters when executing from a [[menu_commands|Menu Command]] or MPL/Python script. | ||
+ | |||
+ | Mystic does its baud rate emulation on the server side, which means that | ||
+ | it will work on any terminal that can connect to your BBS. The terminal | ||
+ | does not have to have any sort of baud rate capabilities like other BBS | ||
+ | systems use which means that Mystic' | ||
+ | on legacy DOS or older system terminals and terminals not designed to be | ||
+ | used with a BBS! | ||
+ | |||
+ | === Event-Based Display Files === | ||
+ | |||
+ | These files are automatically displayed by Mystic at certain times during a user's session if they exist in the current theme' | ||
+ | |||
+ | Note: All file names are lower-cased in operating systems that use case sensitive file names. | ||
+ | |||
+ | ANSICHAT .XXX - This is the template file for the split screen | ||
+ | chat mode. For more information on templates, | ||
+ | see the section on the Template System. | ||
+ | ANSIEDIT .XXX - This is the template file for the full screen | ||
+ | editor. | ||
+ | see the section on the Template System. | ||
+ | ANSIFINF .XXX - This is the template file used when displaying | ||
+ | extended file information during the lightbar | ||
+ | file listings. | ||
+ | ANSIFLST .XXX - This is the template file used to setup the | ||
+ | ANSI lightbar file listings. | ||
+ | on this, see the Editing Template section. | ||
+ | ANSIMLST .XXX - This is the template file used for the lightbar | ||
+ | message reading index. | ||
+ | ANSIMRD | ||
+ | message reading. | ||
+ | ANSIQUOT .XXX - This is the template file for the full screen | ||
+ | editor quote mode window. | ||
+ | on this, see the section on the Template System. | ||
+ | ANSITEXT .XXX - This is the template file for the full screen | ||
+ | text editor. | ||
+ | see the section on the Template System. | ||
+ | AMSGHLP1 .XXX - Help file for ANSIMLST.XXX | ||
+ | AMSGHLP2 .XXX - Help file for ANSIMRD.XXX | ||
+ | BIRTHDAY .XXX - Displayed during login if the user calls on | ||
+ | their birthday. | ||
+ | BLINDUL | ||
+ | file upload. | ||
+ | CLOSED | ||
+ | and the incoming caller did not enter the | ||
+ | correct password. | ||
+ | DOWNLOAD .XXX - Displayed before the " | ||
+ | user attempts a download. | ||
+ | EMAILHLP .XXX - Displayed during the e-mail reading prompt when | ||
+ | the user enters "?" | ||
+ | FEEDBACK .XXX - Displayed before new users are forced to send | ||
+ | the SysOp an e-mail message. | ||
+ | FGROUPx | ||
+ | FLAG1x | ||
+ | FLAG2x | ||
+ | FLISTHLP .XXX - Displayed when help is selected during the | ||
+ | lightbar file listings. | ||
+ | FSEARCH | ||
+ | FSHELP | ||
+ | full screen editor. | ||
+ | GROUPx | ||
+ | LOGOFF | ||
+ | a user selects to log off the BBS. | ||
+ | LOGON1-9 .XXX - Displayed in order from 1 to 9 after a user | ||
+ | successfully enters their password. | ||
+ | NEWUSER | ||
+ | sign up as a new user. | ||
+ | NEWUSER1 .XXX - Displayed after user answers yes to continue to | ||
+ | login as a new user. | ||
+ | NONEWUSR .XXX - Displayed if a new user tries to log in when | ||
+ | Allow New Users is toggled off. The call is | ||
+ | terminated after this file is displayed. | ||
+ | PRELOGON .XXX - Displayed after the user selects their terminal | ||
+ | emulation, and before the " | ||
+ | PROTO .XXX - Displayed as a list of available protocols. | ||
+ | this file doesn' | ||
+ | protocol list. | ||
+ | PROTOB | ||
+ | If this file doesn' | ||
+ | a batch protocol list. | ||
+ | READHLP | ||
+ | the user enters "?" | ||
+ | READSHLP .XXX - Displayed during the message reading prompt when | ||
+ | the user enters "?" | ||
+ | the message base. | ||
+ | SLxxx .XXX - Displayed during login if user has a security | ||
+ | level of xxx or higher. | ||
+ | TELECONF .XXX - Displated when entering the standard | ||
+ | teleconference system, and redisplayed again | ||
+ | after the teleconference help file is displayed. | ||
+ | TELEHELP .XXX - The help file displayed in the teleconference | ||
+ | when a /? is entered. | ||
+ | UPLOAD | ||
+ | user attempts an upload. | ||
+ | | ||
+ | |||
+ | === System Display Files === | ||
+ | |||
+ | These system files are worth looking at and reviewing their content. If some are left unchanged it will show you really have not spent any time setting up or customizing your BBS :) | ||
+ | |||
+ | These file all reside in the DATA directory of your Mystic BBS. | ||
+ | |||
+ | |||
+ | NEWLETTER.TXT | ||
+ | the contents of this file appear as a new BBS | ||
+ | email the user is presented with when their | ||
+ | BBS email account is checked. | ||
+ | | ||
+ | SYSLETTER.TXT - This is a template that contains the contents of | ||
+ | a BBS email that is sent to the sysop when a new | ||
+ | user registers. | ||
+ | | ||
+ | HACKWARN.TXT | ||
+ | someone attempt (and fail) to login to the BBS | ||
+ | using their account name. | ||
+ |
display_files.txt · Last modified: 2023/01/26 07:32 by g00r00