############################################################
#  Color 64 BBS Version 8.1a - Mac OS LTK Build
#  11 February 2026 (ported 06 May 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 Mac OS 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
  (Or you may double-click on "install bbs.command")

BEFORE attempting BBS setup or operation.


############################################################
#  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.

############################################################
#  MACOS COMPATIBILITY
############################################################

The included macOS build scripts have been tested on:

  - Apple M4

The macOS build process automatically:

  - Detects Xcode Command Line Tools
  - Detects or installs Homebrew
  - Builds a compatible version of VICE
  - Applies the ACIA Fix required for TCPSER operation
  - Builds tcpser
  - Installs binaries under:
      ~/vice-acia/bin

To launch BBS environment after install:

  Run "./mybbs-macos.sh" in terminal or double click on "run bbs.command"


Terminal.app is used automatically for launching VICE and
tcpser in separate terminal windows.

############################################################
#  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:

  chmod +x vicebuild.sh
  chmod +x mybbs-macos.sh
  chmod +x mybbs-tcpser.sh
  chmod +x mybbs-vice.sh
  chmod +x install bbs.command
  chmod +x run bbs.command

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

  1) Download and extract the Color 64 package into your
     home directory under a desired folder name
     (example: MyBBS)

  2) Open a terminal and change into that directory

  3) Modify scripts to be executable as was shown above

  4) Run: ./vicebuild.sh or double-click 
     "install bbs.command"

  5) Start the BBS: ./mybbs-macos.sh or 
     double-click "run bbs.command"

############################################################
#  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 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
############################################################
Note: Vice is preset in keyboard settings as "positional" to
best mimic C64 keyboard layout. Setting this to "symbolic"
may inhibit ability to use special characters that are
needed for proper system management.

  - 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
  - May use 1-9 and A-F (think "hexadecimal")

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-macos.sh or double-click "run bbs.command"

From the launcher you may run:

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

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

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