Differences

This shows you the differences between two versions of the page.

--- display_files [2016/04/04 09:35] – g00r00
+++ display_files [2023/01/26 07:32] (current) – g00r00
@@ Line 17: / Line 17: @@
 === Random Display Files ===
-Mystic has the capability to allow up to 10 variations of any display file to be selected a random each time it is displayed.  This is done by changing the last character in the file extension to a number from 1 to 9, but IN ALL CASES at a minimum a file with a 1 must exist for Mystic to select a randomly displayed file.
+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.  If for example the base filename of the display file is "test"
+then any addition files with a .# after the base filename will be included
+and selected to display at random whenever the "test" display file would
+normally display.  For example:
-For example:  If the display file named EXAMPLE.ASC and EXAMPLE.AS1 exists, Mystic will randomly select any one of the following files that may exist for display, because a filename with a 1 as the last character of the extension exists:
+   test.ans
+   test.1.ans
+   test.2.ans
+   test.10.ans
-   EXAMPLE.ASC
+In the above example, any time the "test" display file would normally display
-   EXAMPLE.AS1
+Mystic will randomly select one of the files.
-   EXAMPLE.AS2
-   EXAMPLE.AS3
+=== Terminal Size Specific Display Files ===
-   EXAMPLE.AS4
-   EXAMPLE.AS5
+Mystic allows for display file variations to be defined for custom terminal
-   EXAMPLE.AS6
+sizes and it will select the most appropriate file based on the user's current
-   EXAMPLE.AS7
+terminal size.  For example, if the base display file name is "test" then
-   EXAMPLE.AS8
+variations can be created based on column size, line size, or both.  Here is
-   EXAMPLE.AS9
+an example of creating some column-based variations:
+   test.ans          < Displays to users with less than 120 columns
+   test.c120.ans     < Displays to users with 120-159 columns
+   test.c160.ans     < Displays to users with 160+ columns
+The line size can also be defined as well, for example:
+   test.c132x37.ans   < Displays to users who have 132x37 or larger terminal
+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 "scroller" is requested to display.
+**//(NOTE: The column based file naming also works for all of Mystic's
+template files and menu 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's baud rate emulation will even work
+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's text directory.  The file extension will be excluded from the file name within the table shown below, but the file extensions as explained in the previous section will apply to all of them:
+These files are automatically displayed by Mystic at certain times during a user's session if they exist in the current theme's text directory.  The file extension .XXX is either .ANS or .ASC
 Note: All file names are lower-cased in operating systems that use case sensitive file names.
-^ File Name ^ Description ^
+          ANSICHAT .XXX - This is the template file for the split screen
-| PRELOGON  | Displayed after the user selects their terminal emulation/settings, directly before the login prompt |
+                          chat mode.  For more information on templates,
+                          see the section on the Template System.
-  Placeholder
+          ANSIEDIT .XXX - This is the template file for the full screen
+                          editor.  For more information on this file,
+                          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.  For more information
+                          on this, see the Editing Template section.
+          ANSIMLST .XXX - This is the template file used for the lightbar
+                          message reading index.
+          ANSIMRD  .XXX - This is the tempalte file used for the lightbar
+                          message reading.
+          ANSIQUOT .XXX - This is the template file for the full screen
+                          editor quote mode window.  For more information
+                          on this, see the section on the Template System.
+          ANSITEXT .XXX - This is the template file for the full screen
+                          text editor.  For more information on this,
+                          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  .XXX - Displayed when a user selects to start a blind
+                          file upload.
+          CLOSED   .XXX - Displayed if a System Password has been defined
+                          and the incoming caller did not enter the
+                          correct password.
+          DOWNLOAD .XXX - Displayed before the "Filename:" prompt when a
+                          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  .XXX - Displayed after joining file group x.
+          FLAG1x   .XXX - Displayed during login if user has flag 1x set.
+          FLAG2x   .XXX - Displayed during login if user has flag 2x set.
+          FLISTHLP .XXX - Displayed when help is selected during the
+                          lightbar file listings.
+          FSEARCH  .XXX - Displayed before a file search.
+          FSHELP   .XXX - Displayed if user selects help while in the
+                          full screen editor.
+          GROUPx   .XXX - Displayed after joining group x.
+          LOGOFF   .XXX - Displayed right before hanging up the caller when
+                          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  .XXX - Displayed before asking the user if they'd like
+                          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 "login:" prompt.
+          PROTO    .XXX - Displayed as a list of available protocols.  If
+                          this file doesn't exist, Mystic will generate a
+                          protocol list.
+          PROTOB   .XXX - Displayed as a list of available batch protocols.
+                          If this file doesn't exist, Mystic will generate
+                          a batch protocol list.
+          READHLP  .XXX - Displayed during the message reading prompt when
+                          the user enters "?".
+          READSHLP .XXX - Displayed during the message reading prompt when
+                          the user enters "?" AND they have SysOp access to
+                          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   .XXX - Displayed before the "File Name:" prompt when a
+                          user attempts an upload.
-=== Login Order Of Events ===
-This section will walk through the order of events that occur after a user successfully enters their password and logs into the BBS:
+=== 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   Sent to a new user that has signed up to the BBS
+                          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  - Displayed as a BBS email to users who have had
+                          someone attempt (and fail) to login to the BBS
+                          using their account name.
-  Placeholder