		         _____,----,_______    _____,----,_____,----,_____,----,______,----,
	           _\    /____/\     /____\    /    /\    _    /\    /____/\    /    /_jp!
	          _\ .   \      .    \     .   \_    _____\      .   \      .         /_
	      __ _\ `----,____/`----,____/`----,____/      \___/`----,____/`-----\___/ /_ __
	     \_\\___                                                                ___//_/
	         .  /_   clutchbbs>> _             an old sko0l bbs since `95      _\  .
	         :.. /______________________________________________________________\ ..:
	               :.........................telnet://bbs.clutchbbs.com.........:


                                      Paging Module [Mystic]
				      ~~~~~~~~~~~~~~~~~~~~~~

				ACiDiC Paging Module Developed by n3! 

				   Version 2.0 (Linux/Windows)

			  Updated: Jan, 2023 (Coding On These Cold Days!)

												  

-------------------------------------------------------------------------------------------------------------------
Features
-------------------------------------------------------------------------------------------------------------------

- Text/PushOver/Audio Paging & Login Alerts
- Themes (Prepackaged Themes)
- Email Notifications
- Blacklister
- Sysop Availability Status
- Emergency Chat Override
- Home Automation URL Support

-------------------------------------------------------------------------------------------------------------------
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 (LINUX)
-------------------------------------------------------------------------------------------------------------------

TEXT MESSAGING:

	Download mailsend-go (source code). Uncompress the .zip. Browse to the directory and run the following.
			   
	./configure --with-openssl=/usr
	make
	make install

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

	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/Pushover Only)

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

ENABLE PAGING (Audio Only)

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


ENABLE PAGING (Text/Pushover & Audio)

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


ENABLE LOGIN ALERT (Text/Pushover Only)

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


ENABLE LOGIN ALERT (Audio Only)

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


ENABLE LOGIN ALERT (Text/Pushover & Audio)

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

SYSOP STATUS MESSAGE

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

	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.) Copy cl_paging.mps to your scripts directory and compile
2.) Copy pmdata (directory) to your scripts directory
3.) Copy the theme ansi's to your text directory
4.) Copy the cl_blacklist.txt to your data directory
5.) Copy one of themes settings.ini into the pmdata directory and update to reflect your BBS.
6.) Add your menu items of choice. See above for examples.

LINUX

1.) Copy cl_paging.mps to your scripts directory and compile
2.) Copy pmdata (directory) to your scripts directory
3.) Copy the theme ansi's to your text directory
4.) Copy the cl_blacklist.txt to your data directory
4.) Install linux applications. mailsend-go and mpg123. ** SEE NOTES ABOVE ** 
5.) Copy one of themes settings.ini into the pmdata directory and update to reflect your BBS.
6.) Add your menu items of choice. See above for examples.

THEMES (Optional)

1.) Under pmdata/themes you can copy the files to their respective directories
2.) Copy the settings.ini file over pmdata/settings.ini 
3.) Copy the ansi files to your text directory

NOTES

If you use multiple Mystic themes, just copy the .mpx and pmdata directory into each Mystic themes 
script directory.

That should be it. Give it a whirl.

-------------------------------------------------------------------------------------------------------------------
HOME AUTOMATION
-------------------------------------------------------------------------------------------------------------------

In order to use the Home Automation feature. The idea is to send a URL link that toggles a virtual switch.

Systems that support such options, are Home Assistance, HomeSeer, Hubitat, and many more.

Real World Example:

	Under your Home Automation system you setup an event that watches for for a virtual device to turn on.
	When the virtual switch is turned on it will trigger your Chromecast/Alexa devices to play and audio file.

-------------------------------------------------------------------------------------------------------------------
SUPPORT
-------------------------------------------------------------------------------------------------------------------

CLUTCH BBS
Sysop: niter3
Telnet: bbs.clutchbbs.com
Developer: n3! (niter3)
Alpha Tester: (Hawk Hubbard, Necromaster, maddog, Nighthawk, themadtux)

If you require assistance you can find me at Clutch BBS (telnet://bbs.clutchbbs.com)
