Paging Module v1.4 (Windows/Linux) [Mystic]

 Includes options for
 - Text Messages
 - Audio Playback
 - Sysop availability status message
 - Login Alert (audio and/or text)
 - Email Notifications
 - Emergency Chat Override
 - Blacklist
 - Customizing Options
 
 
DEVELOPED / SUPPORT

CLUTCH BBS
Sysop: niter3
Telnet: clutch.darktech.org
URL: http://clutch.darktech.org
Developer: n3! (niter3)
Alpha Tester: (caphood-Hawk Hubbard, Necromaster, maddog, Nighthawk, themadtux)

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

###### DISCLAIMER

The author will NOT be held liable for any data losses, or damage of any sort.

If you disagree, please do not install.


####### PREREQUISITES / NOTES

  TEXT:

	Windows - Place the mailsend file into the root of your Mystic directory
              Example (c:\mystic\mailsend.exe)
	
		
	Linux/PI - Install libssl-dev first. (example: sudo apt-get install libssl-dev)
			   
			   Download mailsend (source code). Uncompress the .zip. Browse to the
			   directory and run the following.
			   
			   ./configure --with-openssl=/usr
			   make
	           Move mailsend to the root of your mystic directory. (Example: /mystic)

	           *** Notes: In order to use openssl (gmail) you need to install libssl-dev. 
	               Otherwise --with-openssl=/usr will not work ***
		
	
	MAILSEND Download URL: https://github.com/muquit/mailsend/releases/

  
	AUDIO:

		Windows - Place the mpg123 file into the root of your Mystic directory.
				  Example (c:\mystic\mpg123.exe)
	
		
		Linux/PI - Install the "mpg123" package. (Example: sudo apt-get install mpg123)

				   Setup your sudoers files under /etc/sudoers 

				   Here is an example of your sudoers file. This will allow elevated permissions
				   without a password prompt.

				   bbs ALL=(ALL) NOPASSWD: /usr/bin/mpg123 
	
------------------------------------------------------------------------------------------------

####### MENU COMMANDS


ENABLE PAGING (Text)

 To get a status of the sysop availability, add the following menu item.
 
	command: (GX) Execute MPL program
	Data: cl_paging page_text
 

ENABLE PAGING (Audio)

 To use audio paging, set the menu command as follows
 
	command: (GX) Execute MPL program
	Data: cl_paging page_audio


ENABLE PAGING (Text & Audio)

	command: (GX) Execute MPL program
	Data: cl_paging page_all


ENABLE LOGIN ALERT (Text)

	command: (GX) Execute MPL program
	Data: cl_paging alert_text


ENABLE LOGIN ALERT (Audio)

	command: (GX) Execute MPL program
	Data: cl_paging alert_audio


ENABLE LOGIN ALERT (Text & Audio)

	command: (GX) Execute MPL program
	Data: cl_paging alert_all


SYSOP STATUS MESSAGE

	command: (GX) Execute MPL program
	Data: cl_paging status
	
--------------------------------------------------------------------------------------------------

####### EMAIL NOTIFICATION

	In the MPS you need to change the variable "email=0" to "email=1" to enable it
	
--------------------------------------------------------------------------------------------------

####### BLACKLISTING

	The blacklist option will report to the specific end user that you're unavailable.

	You need to create the following file under your data directory called cl_blacklist.txt with the
	users of your choice per line in order to enable it. *The users have to match exactly*

	useralias
	useralias
	useralias
	...
	
--------------------------------------------------------------------------------------------------

####### INSTALL INSTRUCTIONS


WINDOWS

1.) Unzip mod
2.) Move cl_paging.bat, cl_paging.mps, axelf.mp3, and alert.mp3 to your scripts directory. (example: c:\mystic\scripts)
3.) Move the cl_paging.ans to your text directory. (example: c:\mystic\text)
4.) Move mpg123.exe and mailsend.exe to the root of your mystic directory (Example: c:\mystic)
5.) From within your BBS add or change a menu command. *SEE ABOVE EXAMPLES*
6.) Modify cl_paging.bat and update the variables.
7.) Modify cl_paging.mps and update. (more details in mps)
8.) Compile cl_paging.mps. (mplc cl_paging.mps)

LINUX

1.) Unzip mod
2.) Move cl_paging.sh, cl_paging.mps, axelf.mp3, and alert.mp3 to your scripts directory. (mystic/scripts)
3.) Move the cl_paging.ans to your text directory. (mystic/text)
4.) Move the mailsend file to your mystic root directory. (**See above**)
5.) From within your BBS add or change a menu command. *SEE ABOVE EXAMPLES*
6.) Modify cl_paging.sh and update the variables.
7.) Modify cl_paging.mps and update. (more details in mps)
8.) Compile cl_paging.mps. (./mplc cl_paging.mps)


*** Additonal information can be found in the MPS

That should be it. Give it a whirl.

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

######## HELP

If you require assistance you can find me at Clutch BBS (clutch.darktech.org)


