
--.                  .--
--== TEEFAX CONSOLE ==--
--== VERSION X/MMXX ==--
--'                  '--

--== WHAT'S THIS ==--

This is TEEFAX (community Teletext service) client for Console.
It's test with Python 3.7 on Linux. You can run it as Door on
Your BBS. It was tested on Mystic BBS A47.

--== INSTALLATION ==--

Use Python3 (tested on Python 3.7)

Install required packages:

pip3 install requests
pip3 install bs4

It was tested using following packages version:

requests==2.24.0 # for downloading the tti files
bs4==0.0.1       # for parsing the TeeFax index file

You can use it in virtual environment like this:

[root]# yum -y install python-virtualenv
| mkdir -p ~/pyenv
cd ~/pyenv
| virtualenv -p /usr/bin/python3.7 teefax
| source ~/pyenv/teefax/bin/activate
(teefax) | pip install -r reqs.txt

--== CONFIGURATION ==--

The default configuration assumes You'll unzip it to:
/bbs/doors/teefax
If You use different location edit the call of teefax.py in teefax.sh.
Then edit teefax.py and change location of temporary directory in 
variable dirname. That's the place where the downloaded pages will be
downloaded.

--== MYSTIC CONFIGURATION ==--

╔════════════════════════ Command ID 41: default.TOP ═════════════════════════╗
║                                                                             ║
║ Display Text  │ E TEEFAX                                                    ║
║ LightBar OFF  │ TEEFAX                                                      ║
║ LightBar ON   │ TEEFAX                                                      ║
║ LightBar X Y  │ 0  0                                                        ║
║ Hot Key       │ E                                 ┌ GRID MENU JUMPS ─────── ║
║ Access String │                                   │ Up     0     Escape  0  ║
║ Display When  │ User has access                   │ Down   0     Tab     0  ║
║ Redraw After  │ Yes                               │ Left   0     PageUp  0  ║
║ Execute Timer │ 0                                 │ Right  0     PageDn  0  ║
║ Timer Type    │ Every <timer> interval            │ Home   0     End     0  ║
║                                                                             ║
║ Action List ────────────── Access ───── Data ─────────────────────────────  ║
║ (DD) Exec external program              /bbs/doors/teefax/teefax.sh         █
║                                                                             ░
║                                                                             ░
║                                                                             ░
║                                                                             ░
║                                                                             ░
╚═════════════ (TAB) Edit Actions (PAGE) Prev/Next (CTRL+V) View ═════════════╝

--== USAGE ==--

To watch how to use look here:

https://asciinema.org/a/YmamlF6c5yMZsJDDVNSTdl0Mx

Otherwise use:

# - 3 digit number to change page
n - next subpage
p - previous subpage
q - quit

--====================--

Live long, TEEFAX.

