AutoLEECH Documentation

AutoLEECH® 99.24.22 HELP FILE
email: tomt@autotrig.com   website: http://www.autotrig.com

Note: updated for mIRC 6.01 (appears compatible with 5.71, 5.82 & 5.9, 5.91)
No multi-server testing has been performed!

Watch for highlighted items, representing new features or details in this version of AutoLEECH.

  • Overview
  • Installation
  • Upgrades
  • New Installs
  • Uninstall
  • Options
  • AutoLeech
  • AutoSnag
  • AutoList
  • AutoLeech Window
  • Session Manager
  • Trigger Input Dialog
  • AutoSnag Window
  • AutoList Window

     

    OVERVIEW

    The Auto® family has grown with the addition of AutoSnag & AutoList. While incorporated in AL® 99, the 2 latest Auto members are purely optional and available for your use. Note: mIRC 5.6 users, both of the new windows are disabled.

    AutoLeech
    Allows the requesting of selected files from another user that is offer irc dcc triggers.  Very automated to make the process enjoyable and easy.

    AutoSnag
    The "snag" part of the name refers to offers that are "snagged" from an irc channel and retained in a window. This listing makes it easy to see what offers have been made.  More importantly, it makes it simple to create a leech session to download from collection type triggers in the offers or to cause a download of the file from a single file type trigger.

    AutoList
    Similiar to the AutoSnag window, except instead of tracking offers, it makes viewing another users trigger lists (ie: made with AutoTrig® 99) easy.  In addition to requesting downloads from single file and collection type triggers.

     

    INSTALLATION

    Upgrades
    Move unzipped files to mIRC folder.. right click on any nick, in any channel or select "Commands" in the menu bar.. click AUTOLEECH®  then UTILITIES.. and then Upgrade AL® .. press the button.. new upgrade will then be loaded.  The install script will compare your version of mIRC with a list of versions AL® has been tested with.  If the version has not been tested, you will be notified, installation can still continue at your own risk.

    Please note: This method will not work if upgrading from AutoGet®, only an AutoLeech® version!

    New Installs
    Move ALL files to your mIRC folder, then type  /load -rs al_install.mrc then in any window type/al_install  .Once installed you'll see the choices offered by the script by right clicking in an any nick, in any channel or select "Commands" in the menu bar.  Please note, installing AL® will cause any old version of AutoGet to be removed from your mIRC remote window.  The old AG folder and files will be left intact and will need to be removed by hand if you want total removal.

    Uninstall
    This selection allows for removal of AL®.  All AL® script files will be removed from mIRC remote and all AL® variables will be erased from the common variable window.  The AUTOLEECH® folder with scripts and data files will remain intact and will need to be removed by hand if you want total removal. UnInstall is found under Utilities in the main AL® menu.

    OPTIONS
    The Options dialog consists of several pages of option choices. Each with a specific category and itemized below:

    Default Folder Options
    'Collection' Default Folder
    Choose path to BEGIN folder searches

    Primary CSV Default Folder
    Choose path to BEGIN primary CSV file searches

    Missing CSV Default Folder
    Choose location to BEGIN file search for "Missing" CSV's
    (ie: created by The!Checker, ScanSort or Hunter)

    Storage Default:  ( Collection Folder/Holding Folder )
    Choose the default that will appear in the trigger window for each trigger build (can be changed manually with each trigger addition)

    AutoLeech

    Busy Wait Seconds
    Number of seconds to wait following a busy signal before making another request.

    Request Wait Seconds
    Number of seconds to wait before making another request, following the receipt of a file.  This is a default number, attached to an A2 compliant server, it will determine the request wait seconds for you.  Minimum wait time:  when checked, forces AL® 99 to wait at least as long as the "request wait time" you have inputted.  (Helpful if the server from which you are requesting files has a wait time that is shorter than you like)

    Connection Type
    Dropdown box allows you to choose a description that best fits your connection speed.  The purpose is to allow the person you are connecting with to have some idea of your leeching capabilities. (ie: 28.8k, 33.6k, 56k, Cable, ISDN, ADSL, T1 or T3)

    Minimize dcc Get boxes
    Causes mIRC to minimize the dialog boxes associated with dcc Gets.

    Resume Failed Sends
    When checked, if AL® finds a partially completed file in the holding folder, it will resume the the send.

    AL Auto Acknowledge ONLY
    Allows files requested by AL® to be auto acknowledged, all other files are rejected.  There is no option to use this feature with 'ask', testing has shown that once a file is received.. all future files, even if auto acknowledged, must wait for the ask dialog to be cleared.

    Seek CSV in collection folder
    Prevents AL® from searching the collection folder for the collection's csv.  Unless you occassionally place a csv file in the collection folder, this option should be turned off, reducing search times for csv's.

    Enable ACDsee Viewer
    Allows a selection for ACDsee to appear in the AutoLeech® menu. When used ACDsee is invoked and the collection folder being leeched is displayed. The process syncs ACDsee to the folder, and any new scans being received, will be immediately displayed.

    No AL logo screen
    Mutes the AutoLeech® 99 logo screen at startup.

    Mute 'Away' messages
    Mutes other users away messages when sent in response to trigger activity.

    File Received Sound
    Allows you to cause a wav file to be played on your machine at the conclusion of each file receipt.

    Choice of which wav to play when completing a file.

    Leech Complete Sound
    Allows you to cause a wav file to be played on your machine at the conclusion of a collection's leech.

    Choice of which wav to play when completing a collection.

    AutoSnag

    Enable AutoSnag®
    Enables the use of the AutoSnag features.  Note: not available for use with mIRC 5.6

    Offer types to Snag

    Single File Type Triggers
    Retain offers that contain single file type triggers

    Collection Type Triggers
    Retain offers that contain collection style triggers

    FTP (xxx.xxx.xxx.xxx OR ftp://)
    Retains offers that contain this type of ftp info

    URL (www. OR http://)
    Retains offers that include URL details

    New browser window
    When checked, creates a new browser window

    Maximum lines in AutoSnag window
    Adjust the number of offers stored for viewing.

    Note: as new offers enter the window, the oldest offer will be removed to make room when the maximum has been reached. Changing nicks associated with an offer are tracked.  When nicks leave all channels you share, any offers from that nick will be removed. Nicks that display a "Trigs Off" message, will have all offers removed from the window.

    Mute "snagged" offers from channel(s)
    When checked causes the offer to show ONLY in the AutoSnag window and not in the channel window.

    Clear AutoSnag window when re-connecting
    Forces the contents of the window to be cleared of offers with each reconnect.

    AutoList

    Enable AutoList®
    Enables the use of the AutoList features.

    Move trig lists to AL folder 'TrigLists' upon receipt
    Recommend using this feature.  When a trig list is received that contains an AutoTrig® identifier, the file will be moved to the TrigLists folder.  Making it easy to find any trig lists you may wish to view.

    Display TrigLists in AutoList upon receipt
    Anytime a trig list is received and determined to be AT® compatible, the list will be displayed in the AutoList window.

    AutoLeech® Window

    The AL® Window is the heart of the script. It is a view of what is happening with up to nine individual leech sessions.  Important note: Closing this window.. no longer terminates ALL AL® sessions. Upon closing.. there will be an opportunity to continue all active leeches, with the window closed.. or to terminate all active leeches.  With either choice, all sessions that have not reached a conclusion, will be available to continue upon your next AutoLeech® use.

    AL® Right Click Menu

    Edit
    Opens the Session Manager, the same result can be accomplished by double clicking the session line in the AL® window.

    Delete
    Clears the session currently highlighted

    View

    ACDsee
    opens an ACDsee session that is synced to the folder holding the collection being leeched.

    Folder Details
    shows all files currently in the collection folder, and offers the ability to delete files

    AGR Details
    displays the contents of the AGR file associated with the leech session

    Stats
    Displays particular stats for the session highlighted

    Tools

    Change Source Nick
    Allows you change the source nick name, helpful in some lag circumstances, even allows you to begin leeching from someone else.. if the original source nick leaves irc.

    Kill-Send
    Initiates the sending of a message to a server instructing it to kill all current sends to you.  Useful when a send fails but has not timed out on the server end, which prevents further sends.

    Create Folder
    Allows creation of a new folder for holding a collection.  A dialog box prompts for the name of the new folder.. and then a folder dialog alllows you to choose where the folder will be stored.

    Create Trigger
    This selection becomes visible when AutoTRIG is found to be active within mIRC.  When used, the selection results in AT creating a session for creation of a trigger for the collection being leeched.

    Pause/Resume
    Makes available PAUSE/RESUME functions for the highlighted session

    Option pages
    Choose options and defaults for AL®, AutoSnag and AutoList use. Details are listed in the separate OPTIONS section.

    Window

    Hide AutoLeech® window
    Hides the leech window out of sight.

    Save Current Settings
    Save CURRENT window position: after you have sized and position the Offers or Triggers window to suit your situation, simply choose this option to save the size and location information.

    Change Font/Font Size
    Select the name and size of the windows font you want to appear in both the Offers and Triggers windows.

    Desktop Status
    Choice of location for offer or trigger windows within mIRC window or the desktop.

    AGR Tools

    AGR Folder
    Displays all files currently residing in the AGR_Folder located under the AutoLeech folder under the mIRC root folder.  From this view you can choose to remove any .agr file you desire.

    Purge AGR's
    Cause the AGR folder to be scanned for files that have had no modifications to it within 90 days.  Once the files are identified, you are given an opportunity to remove those files if you desire.

    Recycle
    Displays any files that have been moved to the AT/AL Recycle Folder.

    Master Pause

    AL® SESSION MANAGER
    The Session Manager  is a detailed view of an individual leech session.  Allowing you to see the triggers to be leeched from the source nick, along with stats on the session, even the type of server being used by the source nick. You can reach the Session Manager by selecting the menu item in the window right click menu.. or double clicking on the session you want to monitor.

    Trigger Queue
    Displays all triggers currently queued for an individual session. Up to 9 triggers may be queued.

    Add
    Opens the
    Trigger Input Dialog  to create a new trigger to be queued.

    View
    After highlighting the queue line to 'view', this selection allows you to view or edit an existing trigger in the queue.

    Remove
    After highlighting the queue line to 'remove', this selection allows you to delete any triggers in the queue that have not already activated.

    Start/Pause/Resume Button
    This button allows you to do the action listed.. to Start a session, Pause a session or Resume a session.

    < & > Buttons
    Allow you to scroll up or down through the AutoLeech window, from session to session.

    Current
    Displays details of the file currently being downloaded, including filename, csv description field, file size and the crc value of the file according to the csv.

    Files
    Displays details of the current trigger, including the number of files in the collection, the number already collected and the number still needed. 

    Requests
    Displays details of the current trigger, including the number of files received during this leech session, the number missing and the number of either bad file size or crc value.

    Stats
    Displays details of the current trigger, including the time elapsed during file downloads, the bytes received and the number of free bytes remaining on the drive containing the collection folder.  If a filename is not found on the source server, the "Missing" count will be incremented.  If a file on the server does not match the CRC or the file size requested, the "Bad" count will be incremented.. in addition if a file type to be leeched is listed in your mIRC's dcc ignore list, the file will be skipped and the "Bad" counter will be incremented.

    Server details
    Displays the name and version of the senders dcc file server, details of the server including the max number of sends to an individual, the wait time the server requires between finishing a file and the request of the next file, the type of connection used by the server (type or speed), the server protocol, the status of 'Common Channel Restriction' and any time or file limits imposed by the owner of the server.

    Lag duration
    Displays the ping time between the server and yourself. Pressing the button will cause a new ping to be initiated.

    Retrieve List
    Allows viewing the files remaining in the retrieval list.

    Close
    Causes the session manager to be closed.  There are no effects from closing the session manager.

    Trigger Input Dialog
    The Trigger Input dialog allows entry of the details of a trigger, including Source Nick, Trigger ID, Collection path, CSV path. Once the data is created, the trigger may be saved the trigger queue to be activated when the trigger before it is completed.

    Source Nick
    The source nick can be selected by right clicking on the nick in the channel nick list, or by typing it in the edit box. Note: swiping your mouse over a trigger in mIRC, will place it in mIRC's clipboard, if AL® detects valid trigger details in the clipboard it will automatically place the nick and trigger id data in the appropriate boxes of the trigger input dialog.

    Trigger ID
    Refers to the unique part of a trigger command that identifies the collection to be leeched.  Such as !Scanmaster.

    Use of the Trigger ID !atsf will cause the Trigger Input dialog to prompt for a .txt file from your mIRC download folder, making it easier to find a .txt file returned from another user's AutoTrig®/ScanFinder® trigger.  The !atsf Trigger ID will cause AutoLeech® to attempt to request all triggers in the ATSF trigger list.

    Collection Path
    Points to the location of the folder representing the collection to be leeched. AutoLeech® uses this folder to determine if there are already files of the collection in your possession, if so it avoids requesting any existing files. When searching the folder, files found in sub-folders will be considered as found.

    CSV Path
    CSV's will be searched for in possibly three locations by AutoLeech®, the first is the primary CSV folder defined in AL® options. The second is the secondary CSV folder (intended to be the results folder of The!Checker (aka PicCheck) allowing the script to search for a corresponding 'missing' csv created by The!Checker.  The third location is the collection folder itself.  If any matching CSV's are found, they will be displayed in a CSV dialog to choose the one you desire to use.

    If attempting to leech the same collection from multiple sources, be sure to use the SAME csv when selecting this edit box.  AutoLeech® will do all the work when requesting the same collection from multiple sources, please do not attempt to modify CSV's.. it is NOT necessary.

    Storage folder
    The source nick can be selected by right clicking on the nick in the channel nick list, or by typing it in the edit box.

    Collection
    Causes files requested and received by AL® to be moved to the collection folder selected in the Collection Path box.

    Holding
    Causes files requested and received by AL® to be left in the mIRC download folder for other methods of moving to a final location.

    Request with
    Allows you to modify AL®'s method of requesting files when connected to an A2 compliant dcc trigger server.

    Filesize
    Causes the method of AL®'s request to be modified when connected to an A~ compliant dcc trigger server.  The size of the file in bytes will be communicated to the server, if it finds a file with the correct name, but a different file size than requested, the server will not send the file (saving bandwidth) and inform the leech of the discrepancy.

    CRC
    Causes the method of AL®'s request to be modified when connected to an A~ compliant dcc trigger server.  The CRC value of the file will be communicated to the server, if it finds a file with the correct name, but a different CRC value than requested, the server will not send the file (saving bandwidth) and inform the leech of the discrepancy.  The box is available only when the CSV contains a CRC column.

    Please note: Not ALL A2 compliant servers will check the CRC value of a file, however ALL A2 compliant servers will accept the CRC value, even when it is not capable of checking CRC's.

    .extension
    Causes the method of AL®'s request to be modified when connected to an A~ compliant dcc trigger server.  When checked, AL® will send the extension contained in the csv. When unchecked AL® strips the request of any extension.  The box is available only when using a csv that contains extensions in the filename. 

    Please note: a long disliked feature of AutoGet was to append .jpg to ALL files requested. Be aware that AutoLeech® never adds any extension, only extensions contained in the csv file are used in a request!

    ECSV Path
    Causes the method of AL®'s request to be modified when connected to an A2 compliant dcc trigger server.  Collections like 'PhotoShoot' contain many duplicate file names, creating a need for a folder structure to avoid overwriting files that have the same name.. but are actually different photos.  AL® detects ECSV files, when the ECSV box is checked, requests will contain the path information along with the filename contained in the ECSV file to assist the server in finding the correct file. AL® will also create identical file folders in the storage folder to avoid overwriting identical filenames.  Unchecking this box, will eliminate all above functions, and AL® will use the ECSV as a regular CSV.  The box is available only when the file in the CSV path is an actual ECSV format file.

    Overwrite existing .agr
    When AL® begins a leech for the first time, it creates a file to track the files needed to be retrieved, this file has an extension of .agr (a hold over from AutoLeech®'s father, AutoGet.. representing 'auto get retrieval').  If you stop a leech session without completing the retrieval process, the .agr file is retained.  The next time you start a leech with the same name, the old .agr file is used, thus avoiding an additional search.  There are times that this is an undesired feature, and checking this box will cause the old .agr file to be overwritten and a new search conducted. The box is available only when there is an attempt to use an existing .agr file.

    Save Button
    Causes the details of the trigger request to be saved to the trigger queue.

    Cancel
    Closes the Trigger Input dialog without saving any details to the trigger queue.

    Free drive space
    A listing of the space currently available on the selected storage drive, to alert you to any low drive space conditions.

    AutoSnag® Window

    The purpose of AutoSnag is to "snag" offers from all channels you are connected with on irc.  The offers are retained in this window to aid the process of downloading single file triggers and starting leeches for collection type triggers. The window identifies the various types of triggers in an offer and then separates the single files to an area of the AutoSnag window with a color of blue, collection type triggers are grouped together in the green area and ftp and website type triggers are shown in purple.  Double clicking a single file type trigger will cause the download to begin, the same action for collection type folders causes AutoLeech® to start a leech session from the trigger and a double click on a website type trigger will cause your default web browser to display the contents of the address in the trigger. Single file requests will result in the source nick being temporarily added to your DCC Allow List if you are connected to DALnet. Ftp addresses can be easily copied to the clipboard to paste in your ftp client. By clicking the mute button in AutoSnag options you can also cause the offers to display only in the AutoSnag window, thus reducing the clutter in your normal channel windows, otherwise the offers will continue to display to the appropriate channel windows. The AutoSnag window can be quickly scrolled to a particular area just by pressing the alpha character keys. Continuing to press the same key will cause the window to continue to scroll through that character's entries.

    IMPORTANT NOTE: Offers that you display to channels will NOT appear in the AutoSnag® window.  This is by design.. first to cause the offers to appear in your regular channel windows forcing your attention to your own offers, secondly.. to avoid using lines within the AutoSnag® for your own offers which you obviously will not be trying to access.

    AutoSnag® Right Click Menu

    Leech !Trigger
    Causes the highlighted trigger to be used in a new leech session within AutoLeech® if the highlighted offer represents a collection type folder, otherwise the script initiates a request for a download if the trigger is for a single file.

    Request !Trigger.csv
    Causes the highlighted trigger's .csv file to be downloaded from the other users server

    Clipboard
    Causes the highlighted trigger's ID to be copied to the clipboard for your use

    Cut and Paste
    Causes the highlighted offer to appear in a new window where you can choose to cut and paste whatever information you might need, including the entire offer

    Remove Line
    Allows the manual removal of any AutoSnag® line.

    Create Folder
    Allows creation of a new folder by inputting the name of the new folder and then selecting the root folder for the new folder.

    Kill-Send
    Initiates the sending of a message to a server instructing it to kill all current sends to you.  Useful when a send fails but has not timed out on the server end, which prevents further sends

    Ping nick
    Initiates the sending of a ping to the nick displaying the highlighted offer to determine the lag time between you and the nick.

    AutoSnag® Log
    Stores the last 10000 offer lines displayed to any channel you are logged into. After selecting, an entry box allows you to select your search text, or by hitting <enter>, will display all lines currently in the log.  The Log window has a right click menu allowing Cun'N'Paste capabilities.

    Options
    Allows fine tuning the AutoSnag functions to your tastes.  Options listed in the OPTIONS section.

    Sort Type
    Change the sort method to one of 5 options, default: Triggers. Others: Nick, Time, Channel and None.

    Window

    Refresh AutoSnag window
    Removes all offers from nicks that may no longer be on-line, the script is designed to perform that duty itself, although this being the first release of the script, some work still needs to be done.

    Clear AutoSnag window
    Clears all existing offers and triggers showing in the AutoSnag window

    Save Current Settings
    Save CURRENT window position: after you have sized and positioned the AutoSnag window to suit your situation, simply choose this option to save the size and location information.

    Change Font/Font Size
    Select the name and size of the windows font you want to appear in both the AutoSnag window.

    Desktop Status
    Choice of location for the AutoSnag window within mIRC window or the desktop.

    AutoList® Window

    The purpose of AutoList is similar in nature to the AutoSnag window, except it allows you to display another user's trigger list text files. The display will separate the triggers into blue single triggers and green collection triggers. Double clicking the 2 types of triggers will have the same effect as the AutoSnag window. If you select a trigger text file from a user who is not found to be logged into irc, you will be prompted to change the nick (since many times we all use different nicks at different times).  The script is fairly proficient in properly identifying the type of triggers in the list, however there are occasions that a collection type trigger will be misidentified as a single type trigger. Because of that situation, the menu in the AutoList window offers an opportunity to choose to either download a file or start a leech.. with you making the human decision.

    AutoList® Right Click Menu

    Select Trigger List
    Allows selection of an existing trigger text file.  AutoList sets up a "TrigLists" folder under the AutoLeech® folder. It is suggested that you allow the script to move all trigger text files to that folder automatically.  It is also recommended that you manually move all existing trigger text files at installation time to this folder.

    All TrigLists
    Allows the script to search your entire group of trigger lists from various individuals looking for triggers from anyone.

    Search
    Input a string to search for in all of the trigger lists.

    Refresh
    Should be used when several new lists have been received since your last use of "All TrigLists", to refresh the database being searched.

    Leech !Trigger
    Causes the highlighted trigger to be used in a new leech session within AutoLeech®

    Request !Trigger.csv
    Causes the highlighted trigger's .csv file to be downloaded from the other users server

    Request !Trigger File
    Initiates a request for a download of a single file.

    Clipboard
    Causes the highlighted trigger's ID to be copied to the clipboard for your use

    Kill-Send
    Initiates the sending of a message to a server instructing it to kill all current sends to you.  Useful when a send fails but has not timed out on the server end, which prevents further sends

    Options
    Allows fine tuning the AutoList functions to your tastes.  Options listed in the OPTIONS section.

    Window

    Save Current Settings
    Save CURRENT window position: after you have sized and positioned the AutoList window to suit your situation, simply choose this option to save the size and location information.

    Change Font/Font Size
    Select the name and size of the windows font you want to appear in both the AutoList window.

    Desktop Status
    Choice of location for the AutoList window within mIRC window or the desktop.