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

  INTRODUCTION
  ============

  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

  Not much has changed in the last 10+ years in NetRunner, outside of a
  few minor changes and it has been ported to Linux, OSX and Raspberry
  Pi.  Keep in mind versions outside of Windows have had VERY little testing
  so please be considerate of that!

  In any case, I decided to package it up and release it so if anyone
  uses it and has suggestions or issues, feel free to contact me at
  mysticbbs@gmail.com.


  TERMINAL SETUP (BEFORE USING NETRUNNER)
  =======================================

     WINDOWS
     -------

     There isn't much to do for Windows, however, some Windows installs
     have changed their default command prompt colors so that they do not
     quite match up with old DOS-style ANSI colors.

     If you want to fix this, a file named GJ-NCCTF.ZIP by Grymmjack has been
     included which is a registry file that will redefine the colors.  This small
     addon was done by Grymmjack and intended to be used on Windows XP, but
     to my knowledge it works with everything after WinXP too.

     LINUX
     -----

     Most Linux distributions come with a decent terminal that works well
     with NetRunner.  Basically, you want to make sure your terminal has a
     default black color, and that the terminal window size is 80x25.  You
     can of course configure it to basically provide you with a full screen
     80x25 window if you want it to.

     The key is finding a font that displays the IBM CP437 characters used in
     ANSI-BBS so that all of the old DOS ANSI-BBS Glyphs display correctly.

     One I have used recently was ASCII.ttf which I found with a quick Google
     search.  However, it is not the best I've used.  Its really just a starting
     point if your Linux terminal is not already setup for ANSI goodness.

     MAC OSX
     -------

     The setup for OSX is a little more in-depth, simply because Apple doesn't
     seem to like using a standard Linux-style terminal.  There is, however, a
     decent terminal which does operate in a more standard way.  You will be
     almost required to download and use ITERM2 (its free) for your terminal so
     do that first.

     After you have downloaded iTerm2, install your ASCII.ttf font which
     for some reason shows up under the name "New" for me.  Once again, you
     are looking for a monospaced font that can support CP 437 glyphs.

     Here are some basic instructions for setting up a newly compatible
     terminal:

        1. Open an iTerm2 window, right click on it, and select "Edit session"
        2. On "keys" tab, change the two options at the bottom to "+ESC".
 
           Now I am not using an Apple keyboard, and on mine the INSERT key
           does not properly map.  If this is the case for you too, then follow
           these steps:

              1. Still in the Keys tab, click the "+" at the bottom of the window.
              2. Press the INSERT key in the "Keyboard shortcut" box (it will
                 show up as the 'Help' key).
              3. Set the "Action" box to "Send Escape Sequence"
              4. Set "Characters to send" to "[2~" (without the quotes).

        3. On "terminal" tab, change the character type to "Western ISO" and
           term type to "xterm".
        4. On "text" tab, set your ASCII.ttf font (New).  I use it at 24 point
           Anti-Aliased on my box, and I even slightly reduced the horizontal
           and verticle spacing once I had a big ANSI loaded up to make it a
           show ANSI a little cleaner.
        6. Finally, go to the "General" tab and click "Copy preferences to
           Profile" with Default selected.  This will save it so that you
           never have to mess with the settings again.

     RASPBERRY PI
     ------------

     This is a last minute port so it has had the least testing.  Since I believe
     the default PI stuff is configured for international keyboards/keysets by
     default you will need to handle your OS related stuff first.
   
     If anyone wants to write up a small section on how to setup PI to work well
     with NetRunner please do and send it to me!


  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.

  There are a few features (like GLOBAL) that don't really do anything or have
  any use.  There are also a few things that you'd never figure out on your own
  like the BBS name in the phone book allows pipe color codes. :) 


  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


  SUPPORT 
  =======
  
  You should be able to find the latest version at www.mysticbbs.com
  
  You can contact the author at mysticbbs@gmail.com
