
  .---------------------------.
  |  NetRunner Documentation  |------------------------------------
  `---------------------------'

  2.0 BETA VERSION
  ================

  This version of NetRunner is a proof of concept, to assist with
  development of a SDL ANSI graphics engine capable of ANSI-BBS and
  other types of ANSI-similar specifications.

  As of this beta, things seem to be relatively functional and bug
  free, and it is now the recommended version of NetRunner to use.

  The VT102 and non-80x25 screen sizes are still missing, but many
  other features have been added such as a mouse streamlined UI,
  SDL2 ansi engine to give authenticate DOS font and colors.  Amiga
  font and automatic font switching, solid Zmodem with a batch
  upload queue, XTERM mouse support and support for XTERM function
  keys (both used by Mystic BBS now) and probably more that I am
  forgetting.

  Current open issue are: copying to the clipboard is broken, and
  there is an SDL bug that causes beeping when ALT keys are pressed.

  Please see Netrunner.ini for some basic video settings that are
  intentionally left out of the configuration.  Eventually all of
  the configuration and phone book will probably be stored in .ini
  format but for backwards compatibility reasons its not at the
  moment.

  Feedback/ideas are welcome! :)


  OS/X
  ====

  NetRunner does compile and mostly work on OS/X but there are some
  issues that I don't know if are related to the VMware-based OS/X
  version that I am stuck compiling and testing on.  Until I can get
  it stable in that environment and (very) outdated OSX release, I am
  not releasing an OSX version.


  SDL 2.0 / LIBSDL2
  =================
  
  This version of NetRunner currently requires SDL2.dll in Windows or
  libSDL2 to be installed on Linux.  On the very newest distributions
  seem to have an easy package install for libSDL2, so you may end up
  needing to compile your own version.

  The website for SDL2 is: https://www.libsdl.org/


  ABOUT NETRUNNER
  ===============

  NetRunner is a telnet client originally developed in the late 90s in
  sync with the release of Windows XP.  It was intended to be a console
  telnet client which stayed true to ANSI-BBS emulation and the old skool
  feel of DOS terminals.

  The art/UI was designed by Grymmjack, the programming done by g00r00


  USING NETRUNNER
  ===============

  Installing NetRunner is very simple.  The program itself is very small and
  only requires that you unzip it.  There are no install/uninstall
  modifications to your system, no entries added to the registration, no
  random files stored in your profiles (outside of the same directory as
  NetRunner executable).

  When NetRunner is first loaded, it will show a splash screen.  This screen
  will go away by itself after 3 seconds, or will go away if you press ENTER.

  After the splash screen you will presented with the terminal screen.  Use
  the HELP option listed on the status bar at the bottom to get a list of
  available options.  For example, ALT-Z for help or ALT-O for configuration.


  NETRUNNER COMMAND LINE OPTIONS (DEFAULT CLIENT)
  ===============================================

  NetRunner accepts a command line option to auto-connect to a host, and therefore
  can be setup as the default telnet client for your system.  For example, you can
  have it auto load when you click a telnet link on a website.

  The command line format is this:

     NetRunner.exe [address]:[port]

  If no port is provided, NetRunner will assume port 23 (the telnet standard
  port).  NetRunner will also filter out a telnet URL (telnet://) if it
  finds one.


  NETRUNNER PHONEBOOK IMPORT
  ==========================

  NetRunner can currently import both mTelnet and SyncTerm format phone books.

  The IMPORT option is available in the dialing directory.  NetRunner supports
  multiple phone books, so if you'd like to import into their own book, just
  create a new book and then import.


  NETRUNNER SCRIPT LANGUAGE
  =========================

  NetRunner provides a basic script language for logging into a BBS or
  shell automatically.  Since NetRunner also supports auto Zmodem, it can be
  used for things like automatically uploading or downloading QWK packets, for
  example (untested).

  In the phone book editor there is a "script" field for each dialing entry.
  This is where the base file name of your script is entered (each can have
  their own script).

  For example, if you enter TEST, NetRunner will attemptto execute TEST.SCR
  from the Scripts directory (configurable in NetRunner's configuration).

  The scripting language has only a few simple commands, but they should be
  enough to get basic tasks done.

    DELAY   <ms>   : Delays for a specified number of milliseconds.
    SEND    <text> : Sends text to the remove server
    WAITFOR <text> : Waits for text to be received from the server.
    QUEUE   <file> : Adds <file> to upload queue (if it exists).

  All <text> or <file> options are enclosed in quotation marks, and are double
  quoted if you wish to send a quotation mark.  The SEND command has a couple
  codes which NetRunner will replace with the appropriate values for the
  server you are connecting to:

    @CR - Sends a carrage return (ascii char #13)
    @LF - Sends a line feed character (ascii char #10)
    @UN - Sends the user name set in the dialing directory for this server
    @PW - Sends the password set in the dialing directory for this server.

  An example TEST.SCR might look like this:

    Delay 500                       <- Delays for 1/2 second
    WaitFor "name:"                 <- Wait for text "name:" to be received
    Send "@UN@CR"                   <- Send user name and ENTER
    WaitFor "password:"             <- Wait for text "password:"
    Send "@PW@CR"                   <- Send password and ENTER
    Queue "c:\netrunner\myqwk.rep"  <- Add file to upload queue

    ; at this point the script would automatically navigate to the message
    ; menu and upload the QWK packet, then logoff.


  SUPPORT 
  =======
  
  You should be able to find the latest version at www.mysticbbs.com
  
  You can contact the author at mysticbbs@gmail.com.  The email is checked
  often or not often, depending on my work schedule and how much time and
  desire I have work on things. :)
