############################################################
#  Color 64 BBS Version 8.1a - Linux LTK Build
#  11 February 2026
############################################################

Maintained by:
  Mike Newkirk

Support:
  Web:    www.itchybutt.org
  BBS:    itchybutt.org:6502
  Email:  nuke@itchybutt.org

Manual & defect status:
  color64wiki.itchybutt.org

Significant contributions from:
  Darkstar at Arrakis BBS
  atl.ddns.net:6403

VICE installer and build automation courtesy of:
  Al Derosa

############################################################
#  GREETINGS
############################################################

This is a PRESET BUILD of Color 64 BBS version 8.1a, a modified
and updated version of Color 64 version 8.1, provided in a
near-ready-to-run state for Linux systems.

The goal of this build is to minimize setup effort while
preserving the behavior and configuration flexibility expected
by experienced Color 64 sysops.

############################################################
#  IMPORTANT - READ BEFORE CONTINUING
############################################################

THIS BUILD REQUIRES A CUSTOM-BUILT VERSION OF VICE.

In order to properly connect Color 64 BBS to TCPSER, a modified
version of the VICE emulator with the ACIA FIX applied is
REQUIRED.

You MUST run:

  vicebuild.sh

BEFORE attempting BBS setup or operation to ensure settings
are within your operational requirements.


############################################################
#  WHAT vicebuild.sh DOES
############################################################

The vicebuild.sh script will automatically:

  - Detect your Linux distribution and package manager
  - Install required build dependencies
  - Build and install a compatible version of VICE
  - Apply the ACIA Fix required for TCPSER operation
  - Ensure the x64sc emulator is available in your system PATH

If any required component is missing, the script will stop and
display a clear error message explaining what needs attention.

############################################################
#  LINUX COMPATIBILITY
############################################################

The included scripts are designed to run on most popular Linux
distributions, including but not limited to:

  - Debian / Ubuntu
  - Linux Mint
  - Fedora (dnf4 and dnf5)
  - Rocky Linux / AlmaLinux / CentOS Stream
    (may require additional repositories)
  - Arch Linux / Manjaro / EndeavourOS
  - openSUSE Leap / Tumbleweed

Scripts automatically detect:

  - Package manager (apt, dnf, pacman, zypper)
  - Terminal emulator (xfce4-terminal, konsole, gnome-terminal,
    xterm, and others)
  - Required binaries (VICE, tcpser)

If a required component cannot be found, the script will exit
with a clear and descriptive error message.

############################################################
#  DOCUMENTATION AND SUPPORT
############################################################

For installation and configuration guidance, keep one of the
following available:

  - Color 64 Sysop Manual (version 8.1a preferred)
  - Online manual:
    https://color64wiki.itchybutt.org

LTK-specific notes:
  https://www.color64wiki.itchybutt.org/index.php/LTKNotes

Technical support forum (Discourse):
  https://www.itchybutt.org

############################################################
#  BEFORE YOU BEGIN
############################################################

Please verify the following before executing any scripts:

  - All script files (.sh) are executable:
      chmod +x *.sh
  - Script files remain in their original directories
  - Scripts are run from a normal user account (NOT root)
  - Your user account has sudo privileges

Scripts automatically resolve their own paths and normally do
NOT require manual editing for different Linux distributions.

############################################################
#  INSTALLATION
############################################################

  - Install the Color 64 BBS build in your user home directory
  - Do NOT install as root
  - Do NOT relocate scripts unless you understand the layout

############################################################
#  OPTIONAL - EMAIL NOTIFICATIONS
############################################################

If you wish to enable email notifications of BBS activity:

  1) Ensure python3 is installed
  2) Modify notify.py with:
       - SMTP server information
       - Email username and password
       - Recipient address
  3) Modify the sqrt symbol BBS.INIT program:
       - Lines 35705-35706 must match the username and password
         used in notify.py
       - Verify your PC's local IP address in this section
  4) Edit mybbs.sh and remove the comment (#) from the
     python3 notify.py line
  5) While the BBS is running, press the UP ARROW key
       - (Backslash key on a PC keyboard)
       - Toggles notifications ON/OFF at the call screen

############################################################
#  BBS SETUP NOTES
############################################################

  - BOOTMAKER has already been completed
  - Main Parameters in +SETUP are preconfigured
    (Review optional but recommended)
  - MODEM INIT string in +SETUP is already properly defined
  - Two games are prebuilt and operational
  - Additional games are included on D64 disks 4 and 5
      - Update the "games menu" on LU 2 / User 3 as needed

############################################################
#  LTK FILE STRUCTURE
############################################################

LU 0 / User 0
  - Program files
  - System files
  - Help files
  - Text files
  - Caller Log
  - Network files

LU 1 / User 0
  - Public and Private messages

LU 1 / User 1-5
  - Download categories 1-5

LU 1 / User 15
  - Uploads

LU 2 / User 0
  - Aux 1 Files (User Signatures)

LU 2 / User 1
  - Aux 2 Files (not used in this build)

LU 2 / User 3
  - Aux 3 Files (Game Area)

LTK-specific modifications from the original Color 64 8.0 disks
have been incorporated as recommended by the original developers.

############################################################
#  RUNNING YOUR BBS
############################################################

  1) Open a terminal
  2) Change into the directory containing the Color 64 v8.1a
     LTK build
  3) Run:

       ./mybbs.sh

From the launcher you may run:

  - L +BBS     Load and run the BBS
  - L +SETUP   Enter BBS setup
  - L +EDITOR  Edit system screens

TCPSER is preconfigured for port 8502.
Edit mybbs-tcpser.sh and config\config.ini to change this.

Refer to the Sysop Manual for additional information on system
files, configuration, and daily operation.

############################################################
#  END OF README
############################################################
