Title    : RCS Animated Pause Prompt
Filename : rcspau33.zip
Author   : Black Panther
Release  : 15 Nov 2020
Version  : v3.3
ReleaseBy: RCS MPL Division

------------------------------------------------------------------------------

Operating System:   [X]Linux64   [X]Linux32   [X]Windows64   [X]Windows32
BBS Software    :   [X]Mystic   [ ]Synchronet   [ ]Other______________
Release Type    :   [X]MPL   [ ]Door   [ ]Text   [ ]Other_____________

------------------------------------------------------------------------------

World Headquarters for RCS software:
Castle Rock BBS
Sysop: Black Panther(RCS) aka Dan Richter
telnet://bbs.castlerockbbs.com
http://www.castlerockbbs.com

Official Beta Test/Distribution site for RCS software:
The Underground
Sysop: The Godfather
telnet://theunderground.us:10023

Official Distribution site for RCS software:
Agency BBS
Sysop: Avon
telnet://agency.bbs.nz
http://bbs.nz

Official RCS Distribution Network
fsxNet
http://fsxnet.nz

------------------------------------------------------------------------------

License:
   RCS Animated Pause Prompts
   
   Copyright 2020 Black Panther(RCS) <dan@castlerockbbs.com>
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
   MA 02110-1301, USA.

------------------------------------------------------------------------------

Description:
RCS Animated Pause Prompts v3.3 is written in MPL (Mystic Programming Language)
for use with Mystic BBS v1.12A46+

Replace those boring static >PAUSE< prompts within Mystic. Give it some color,
some animation, give them some life! :)

This program is really easy to install and run within Mystic. It involves 
changing one prompt in Mystic to run the compiled MPL.

Creating your own prompts are easy with a simple text editor, or you favorite
ANSI editor. Just make sure line one contains a number, which is the delay 
time when displaying the prompt.

You can also force the MPL to display only one prompt file by specifying it on
the command line. If you find one you really like, in the setup instructions
below, change the command for the prompt to: rcspause filename.ans 
It will only display that prompt.

This MPL was originally written by g00r00 for an earlier version of Mystic. He
has since released a newer version that will run with current versions of 
Mystic, but it was still lacking functionality. This version has quite a few
changes that I think you will enjoy.

------------------------------------------------------------------------------

Files included:

  rcspause.mps   Main program script. Must be compiled
  sysop.txt      This information text file
  file_id.diz    ASCII description file for BBS use
  file_id.ans    ANSI description file for BBS use

Directory included:

  anipause/      Subdirectory of your Mystic scripts directory
                   Contains all of the prompt files
 
------------------------------------------------------------------------------

Change Log

3.0     - Updated prompt number in instructions
        - Updated prompt number for timeout
        - Added keypress function to pass key back to Mystic
        - Added ability to specify prompt to be displayed on command line (optional)
        - Moved prompts to separate directory
        - Removed file name restrictions
        - Changed MaxFrames to 150
        - Now reads ANSI files and TXT files. Extension doesn't matter
        - Number of prompts is theoretically unlimited
        - Added logging to indicate inability to find prompt files
        - Added DeBug logging via boolean
        - Set subdirectory as const variable
        - Removed the cursor from being visible during execution of MPL
            (This will depend on which terminal is used)
        - Removed inactivity timeout if Mystic is set for 0

3.1     - Set subdirectory as const variable
        - Removed the cursor from being visible during execution of MPL
          (This will depend on which terminal is used)
       - Removed inactivity timeout if Mystic is set for 0
       - Included putting visible prompt back on screen if user times out
       - Added check to not read sauce info from ANSI files
         (Don't use PabloDraw to create ANSI files)
       - Removed separate variable for file extension as it's unneeded
       - Change cursor colors when exiting

3.2    - Added const for X,Y axis starting point
         The prompts are default for 80 columns, so if you are running in 132
         columns, you will need to set the X axis to 26 to center them on your
         screen. (132-80)/2

3.3    - Added option for setting the X,Y starting point
       - Forced a writeln to hopefully not start in middle of screen

------------------------------------------------------------------------------

Installation:

1) Unarchive and place the rcspause.mps into your Mystic scripts directory.

2) Open rcspause.mps in your favorite text editor. Take a look at the Const
   section. If you want to be able to indicate where on the screen the pause
   prompt displays, set the 'Set_POS' boolean variable to 'true'. Also, you
   might want to change the 'X_AXIS' and 'Y_AXIS' settings.

   If you would like the pause prompt to display wherever Mystic gives the 
   coordinates for, make sure 'Set_POS' is set to 'false'.

3) Go to your shell and run this command from the prompt, in your main Mystic
   directory:

   Windows >
   c:\mystic\
   mplc -t

   Linux and Mac >
   (make sure to give this script the right ownership and permissions)
   /home/bbs/mystic/
   ./mplc -t

4) If you've compiled it properly it should give you a success
   response from the terminal and a rcspause.mpx should display from
   the scripts directory.

5) Go to your system configuration.

   Windows >
   (Navigate to your BBS root directory)
   mystic -cfg

   Linux or Mac >
   ./mystic -cfg

   - Move <RIGHT> to the "Editors" Tab

   - Go down to Theme/Prompt Editor selection

   - Select theme you would like to install into

   - Select '1: Prompts

   - Scroll down to prompt #22

   - Remove what is contained in that prompt, and type in !rcspause

   - Hit escape to exit the editor, and hit 'Y'es to save changes.

   - If you are currently logged into your BBS, go to the Account Settings
     and re-select your theme to reload the prompts. 

   - When you go to something like Who's Online, the animated prompt will
     be displayed at the bottom of the screen. :)


