/ScriptServ

;-------------------------------------------------------------------------
;
; Name: XDCC Autoresume/Autoqueue Stealth Script
; File: XDCCStealthHelp.mrc
; Version: 4.1.5
; Author: Werecow
; Date: 23-02-2005
;
; Contents: The help text output for the XDCC Stealth script.
;
;
; WARNING: many channels will ban you for using XDCC leech scripts. While this is a silly rule,
; it is your responsibility. Use this wisely. Don't use it in such channels, or don't get caught.
; And play nice for the other people that want to use the XDCCs! If you leech em dry other people 
; may be unable to get on.
;
;-------------------------------------------------------------------------








;-------------------------------------------------------------------------
; /XDCChelp:
; Small help file on how to use the script.
; Can be triggered from the channel, status, nick, or @XDCC_Info menu, or 
; menubar > commands. 
;-------------------------------------------------------------------------
alias XDCChelp {
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
  /outputxdccinfo 4WARNING7: Many channels will ban you for using XDCC leech scripts. While this is a silly rule it is your responsibility. Use this wisely. Don't use it in such channels, or don't get caught. And play nice for the other people that want to use the XDCCs! If you leech em dry other people may be unable to get on.
  /outputxdccinfo  
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
  /outputxdccinfo 6Before we get started:
  /outputxdccinfo 
  /outputxdccinfo 5The script must capture the triggers and packlistings for a bot before it can be used on that bot, so the first thing you must do is idle in an xdcc channel and let the in channel xdcc ads scroll by for a while. The capturing is fully automatic. Once a trigger has been captured, you can begin using the script. 
  /outputxdccinfo 5There is an XDCC menu item under your right mouse button. It will prompt you for more input if needed or perform the action on the selected nickname. Some functions can be used on multiple nicknames at the same time. 
  /outputxdccinfo 5If an option says it applies to "selected bot(s)", the function will be performed on all bots currently selected in the nicklist (the first bot selected is the only one mentioned in the menu item title). This means you can perform some functions on single, as well as multiple bots at the same time. 
  /outputxdccinfo 
  /outputxdccinfo 5The nicklist in the special @XDCC_Info window, if switched on, has color codes that tell you whether a bot is 9downloading5, successfully remotely queued5, 5waiting for a remote queue slot to open5, 6waiting for new connections to be allowed5, $& 
    4failed5, 2suspended5, 13trying to join a channel5, 12just joined a channel and trying to queue a pack5, 14unreachable because you're not on the same network5, 10unknown status because you're not in the same channel5, 7online and in the same channel as you5, or 1offline5.
  /outputxdccinfo 
  /outputxdccinfo 13Files used:
  /outputxdccinfo 
  /outputxdccinfo 5Note: The "XDCC Pack library" consists of the3 network5¦7bot5.pff files. These files store the info on the packs, while the *.apf files store non-bot-specific information such as the currently acquired triggers or the bots that are currently downloading. $&
    $triggerHash is the most important file in the apf section, as it stores the bot triggers and other information about the bots. It is not recommended to edit this file by hand, and if the script is running, it's actually rather useless because the information you edit will most likely be overwritten. 
  /outputxdccinfo 5The 3network5¦7bot5.q files hold the bot specific queues, whereas active queue information for a network (like the information used when using autoresume at start) is stored in a 3network5.apf file. $&
    The .old files store temporary information used to check for changing packs on an XDCC bot. You can change most of the filenames and the directory used if you go to 12Settings > 12Filename Settings5. The filename you choose when renaming a file should not exist. The new directory should exist, but the script can create directories on one level directory depth. If you don't specify a full path, the directory will be created in your IRC home dir.
  /outputxdccinfo 
  /outputxdccinfo 6Main menu commands:
  /outputxdccinfo 
  /outputxdccinfo 13Basic queue actions:
  /outputxdccinfo 
  /outputxdccinfo 12You can add bot specific queues by entering the packnumbers you wish to download, if you choose 12Add XDCC Queue For Bot <Bot Name>5. Use a format like "1 2 4-10 12" when entering the pack numbers. This example would queue up packnumbers 1, 2, 4, 5, 6, 7, 8, 9, 10 and 12. $&
    You can use this same format in 12Remove XDCC Queue For Bot <Bot Name>5, obviously with the opposite result.   12Clear XDCC Queue5 will remove all your queued up packs for the selected bot at once. The downloading will not start untill you choose 12Start Processing Queue File5. This will start downloading the requests in the queue for the specified bot one by one. 
  /outputxdccinfo 5You can halt a queue temporarily (and prevent a file from being automatically re-requested when the transfer fails) by choosing 12Suspend Autoqueue And Auto Re-Request 5for that particular bot. This will not remove the currently sending or queued pack from your queue, and it will not halt any current transfers. You can restart the queue where you left off by choosing 12Start Queue 5again later on.   
  /outputxdccinfo 12Remove a pack from ALL XDCC queues by Name5 will remove a pack based on it's pack description. When using this, be as precise as you can in the pack description. If you're not precise enough, you may accidentally dequeue packs you want to keep queued. Try entering the pack description exactly as it is in the bot library. $&
    For instance: 'blah' will remove all wildcard matches for *blah*, including 'blah.divx', 'blah.divx.cd1.tar', 'blah.cd2.divx' and 'blah.2.divx.tar', whereas 'blah.divx' will only remove the first two, and 'blah.divx.cd1' will only remove the second. 
  /outputxdccinfo 12Stop all current downloads for bot5 will halt any and all currently active incoming transfers for the selected bot(s), without triggering the auto resume function. 
  /outputxdccinfo 12Stop all current uploads for bot5 will halt any and all currently active outgoing transfers for the selected bot(s), without triggering the auto send resume function. 
  /outputxdccinfo 
  /outputxdccinfo 13Bot Queue actions:
  /outputxdccinfo 
  /outputxdccinfo 12Add Bot to Bot Queue5 will add a (number of) bot(s) to the Bot Queue. 12Remove Bot from Bot Queue5 will remove a (number of) bot(s) from that file. This secondary queue feature allows you to process the bots you have queues for automatically in a smooth row, rather than all at once, or manually. $&
    12Clear Bot Queue File5 will remove all bot queues at once. 12Start processing First N Bots in bot queue file5 will start queues for the first N number of bots (where N is a number you entered) that are in the queue file.
  /outputxdccinfo 12Remove <BOT/NETWORK> Entirely From Bot Library 5will remove all files and entries related to this3 network5¦7bot5 pair. It will only show up in the nicklist menu.
  /outputxdccinfo 
  /outputxdccinfo 13Searching XDCC packs:
  /outputxdccinfo 
  /outputxdccinfo 12Find XDCC Pack5 will search all bots in your library for any packs that match the string you entered. This is sensitive to word order, but it will respond to partial words or sentences as well as full descriptions.
  /outputxdccinfo 5If you want to look at the packs for a given (number of) bot(s), channel or network, you can choose the appropriate option. 12Browse All Known XDCC Packs For Bot/Channel/Network5 will list all packs for the selected target. Be aware that channel and especially network listings can be in the thousands of items. 
  /outputxdccinfo 
  /outputxdccinfo 13Queue Listings:
  /outputxdccinfo 
  /outputxdccinfo 12Show All Currently Active Bots5 will show all bots that you have started queues for, whether they are queued, active, or waiting for a bot to come online. 
  /outputxdccinfo 12Show all queues for all bots5 will briefly list all bots with their queued up pack numbers, whereas 12Show detailed Queues for all bots5 will list all queues for all bots, with the pack descriptions. Choose 12Show detailed Queue for specific selected bot(s)5 to view a (more selective number of) bot(s)'s detailed queue.
  /outputxdccinfo 5Finally, you can view the secondary queue by choosing 12Show Bot Queue5.
  /outputxdccinfo 
  /outputxdccinfo 13Remaining Listings:
  /outputxdccinfo 
  /outputxdccinfo 12Show all completed file receptions5 will show you all completed downloads from the current session.
  /outputxdccinfo 12Show all completed sends5 will show all completed uploads this session.
  /outputxdccinfo 12Get XDCC Library Statistics5 will show you a small number of statistics for the script.
  /outputxdccinfo 
  /outputxdccinfo 13Miscellaneous Commands:
  /outputxdccinfo 
  /outputxdccinfo 12Remove <BOT/NETWORK> Entirely From Bot Library 5will remove all files and entries related to this3 network5¦7bot5 pair, including queues, triggers, and pack listings, and remove that bot from the nick list for the separate output window (if the window and bot list are active).
  /outputxdccinfo 12Clean XDCC Library5 will remove all .pff files and their appropriate triggers if they are older than the number of days mentioned (unless you have a queue for the matching bot). It will also remove all .old files, unless a pack change test is pending.
  /outputxdccinfo 12Add/Change key for channel5 allows you to provide the script with a key needed to join a channel. This is useful if the script attempts to join that channel automatically if a bot that has an active queue requires you to be in the same channel with it.
  /outputxdccinfo 12Toggle DCCALLOW Support for Network5 makes the script do a /DCCALLOW +Nick every time it starts a queue. Only switch this on for networks that require this feature, otherwise it can be annoying and suspicious. 
  /outputxdccinfo 12XDCC Get Help5 will show this help file.
  /outputxdccinfo 12Check for new script version5 will check for a new version of this script and will prompt you to download it if it is available. You can only request a version check from the script's author (that's me, $xdccscriptauthor $+ ) is online on the same network as you are.
  /outputxdccinfo 12About5 will tell you a few things about the script itself. 
  /outputxdccinfo 
  /outputxdccinfo 6Settings menu options:
  /outputxdccinfo 
  /outputxdccinfo 5In the 12Settings5 submenu one can switch ON or OFF a variety of this script's features. This next part of the helpfile will discuss these settings one at a time. $&
    The settings themselves are located in the 12Settings5 submenu, whereas the actual commands that make use of them are either automated, or located in the main XDCC menu, which we have already discussed in the above. Check the help file in the Settings submenu to find out about what these features do. Some features are disabled by default because they're more subtle, but you may want them enabled.
  /outputxdccinfo 
  /outputxdccinfo 6Happy hunting!
  /outputxdccinfo 
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
}
;-------------------------------------------------------------------------
;-------------------------------------------------------------------------



;-------------------------------------------------------------------------
; /SettingsXDCChelp:
; Small help file on the script's main settings.
; Can be triggered from the channel, status, nick, or @XDCC_Info menu, 
; or menubar > commands. 
;-------------------------------------------------------------------------
alias SettingsXDCChelp {
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
  /outputxdccinfo 6Settings menu options:
  /outputxdccinfo 
  /outputxdccinfo 13XDCC Get main features:
  /outputxdccinfo 
  /outputxdccinfo 12Autoresume 5automatically re-requests your failed downloads (if it knows the bot's trigger and the pack number of the failed download).
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Autoresume On Bot Rejoin5 will automatically resume a transfer when an activated (but offline) bot comes back online. These first two functions have been divided into separate items from version 1.22.16, and shutting one down (or switching it on) will not influence the other. 
  /outputxdccinfo 
  /outputxdccinfo 12Autoqueue 5automatically queues up the next download for a bot (only packnumbers specified by you) whenever one finishes (if there are any packs still in that bot's queue). 
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Bot Queue Handling5 will enable or disable the more advanced Bot Queue feature, which uses a secondary queue file that lists entire bots, rather than pack queue items. If switched on, once a bot completes it's entire queue, the script will move on to the next bot listed in the bot queue file. $&
    This continues until all bots in the bot queue file have completed their entire queues. Note that the bot queue feature will only work if the Auto-Queue feature is also switched to ON. 
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate automated timed checking for available download slots/bandwidth5 is a feature that has two possible settings: bandwidth, and number of transfers. It will automatically check every so often whether all available bandwidth, or the maximum allowed download slots, is used. If there is room for more, it will start up a new download using the botqueue. You can switch modes using 12Swap mode for connection availability testing5. If you use this, don't forget to set your prefered maximum and minimum slots or bandwidth, and your system's total bandwidth (in Kilobytes).
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate AutoResume At IRC Start 5will toggle the option to resume transfers that were active when IRC closed on startup (or whenever a connection is made to a server on an appropriate network). This is useful for, for instance, resuming downloads that were active during a system or program crash. $&
    Switching it off will not affect the normal autoresume function. By default it is turned OFF. This is because packlistings may change while you are offline, thus having the script request the wrong pack. However, this is very unlikely if you have only been gone for a short while, like the few minutes it takes to reboot after a system crash.
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Auto Retry at No New Connections notice 5will, if switched ON, attempt to re-request a pack after a (usually large) number of seconds, if a bot owner refuses to send a pack and notices you that he has requested that "No New Connections be made in the next N minutes".
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Auto Join at Bot Request 5will, if switched on, react to the requirement that some bots need you to be in a serving channel with them before they will send you any packs. It will auto-join a channel where the bot was known to have been and re-request the file on a timer. Be sure to add keys for your  channels where appropriate. 
  /outputxdccinfo 
  /outputxdccinfo 5Switching12 Activate/Deactivate AutoRemove at bot removal confirmation5 ON will make the script automatically remove items from your queue files if you dequeue them from a bot by sending that bot a /msg BOT xdcc remove message. It can only remove items that it can find a match for in the library. Any others will stay in the .q file.  
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Attempt to Clean Pack from ALL Bot Queues on Pack Complete5 does basically the same thing as 12Remove a pack from ALL XDCC queues by Name5 (only it does so automatically for each completed download to prevent double requests), and thus it has the same drawbacks. Be thorough when inputting a removal string. $&
    For instance: 'blah' will remove all wildcard matches for *blah*, including 'blah.divx', 'blah.divx.cd1.tar', 'blah.cd2.divx' and 'blah.2.divx.tar', whereas 'blah.divx' will only remove the first two, and 'blah.divx.cd1' will only remove the second.
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Packfile Change Tracking5 will, if switched ON, warn you when a pack listing for a bot seems to have changed. It is disabled by default because the warnings can be annoying when you are in a channel with a lot of xdccs that change their packlistings quite often. However, it is also useful to prevent you from queueing up the wrong packs, or informing you of new pack additions or removals.
  /outputxdccinfo 
  /outputxdccinfo 12Activate/Deactivate Queue Position Tracking5 will simply inform you every time a bot notices you that your queue position has changed. You can usually see these notices in the bot's channel or server window as well, but it may be handy for keeping the bot messages in somewhat clearer sight when visiting very busy channels. It will only inform you if your queue position actually changes. It is switched OFF by default.
  /outputxdccinfo 
  /outputxdccinfo 12Auto Clean XDCC Library At Startup5 will automatically clean the library on script start. This is disabled by default, because it takes a while to clean the library. 12Clean old files from Bot Library5 is the manual variety to this automated feature. It will remove files older than the number of days set by 12Set library file expiration date5. Doing this cleaning every once in a while prevents the library from becoming poluted with old bots that are no longer active. Default expiration time is set to 40 days. 
  /outputxdccinfo 
  /outputxdccinfo 13XDCC Send main features:
  /outputxdccinfo 
  /outputxdccinfo 5Switching12 Auto Resume Sends 5on will resume your sends if they fail to complete. This is switched OFF by default, since it can be annoying for the recipient if they try to cancel the u/l but fail to do so because it insists on resuming. For that reason the send autoresume function is temporarily disabled for that recipient after a send is resumed.
  /outputxdccinfo 
  /outputxdccinfo 12 Set AutoResume Send bandwidth Limit 5will set an upper bandwidth limit to your autoresumed sends. This is not a total bandwidth limit, but a limit PER SEND.
  /outputxdccinfo 
  /outputxdccinfo 13Miscellaneous Settings features:
  /outputxdccinfo 
  /outputxdccinfo 12Write debugging log file5 Writes a log file that can be used to filter bugs from the script. It is not necessary to turn this on unless your script locks up your IRC.
  /outputxdccinfo 
  /outputxdccinfo 5The 12window options 5allow you to choose where the information from the xdcc script goes. This information includes pack searches that you do, autoresume or queue notices, and error reporting. You can choose to report to the currently active window, to the server status window, to a window created specifically for this purpose, or to both the active window and the special window. 
  /outputxdccinfo 12Set Separate Output Window Font 5will set and store the font for the separate output window.
  /outputxdccinfo 12Toggle Bot List View 5will show a list of all bots in the triggerHash file. You can perform actions on this list like you can in a channel nick listbox.
  /outputxdccinfo 
  /outputxdccinfo 5The 12Timer options5 should only be changed if you know what you're changing, as they are the core of the script's stealth. There is a specific 12Help5 file on the timer settings in the timer options submenu.
  /outputxdccinfo   
  /outputxdccinfo 5You can save or load your settings in a .set file by choosing 12Save XDCC Script settings5 or 12Load previously stored XDCC Script settings5 respectively (Do not enter a filename, but only a profile name. The extension will be added automatically, and illegal characters should be filtered out). If a certain setting is not found when you load a profile, the default value will be used. 
  /outputxdccinfo 5Finally, If you changed something and the script stopped working properly, you can choose to 12revert ALL settings to their default values5. You won't lose queues or bot data, but all timer, window and filename modifications you made are reversed, and some features will be switched on or off. 
  /outputxdccinfo 
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
}
;-------------------------------------------------------------------------
;-------------------------------------------------------------------------


;-------------------------------------------------------------------------
; /TimerXDCChelp:
; Small help file on how to set timer settings.
; Can be triggered from the channel menu under Timer Options. 
;-------------------------------------------------------------------------
alias TimerXDCChelp {
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
  /outputxdccinfo 6Timer Menu Options:
  /outputxdccinfo 
  /outputxdccinfo 12Set delay for auto resume reactivation:5 When requesting a resume for a failed transfer the auto-resume script is temporarily disabled to prevent an unwilling server from being spammed with requests. Mostly, this would be caused by a server that continually times out, so this value should be set no lower (and preferably somewhat higher, just to be safe) than your DCC Get timeout value.
  /outputxdccinfo 
  /outputxdccinfo 12Set minimum delay for item resume request:5 To simulate a human being controlling the requests, the script uses a random timer before requesting a resume. This sets the lower boundary for this random time value. You should at least give it a second.
  /outputxdccinfo 12Set maximum delay for item resume request:5 To simulate a human being controlling the requests, the script uses a random timer before requesting a resume. This sets the upper boundary for this random time value. You should at least give it a few seconds.
  /outputxdccinfo 12Set minimum delay for next queue item request:5 To simulate a human being controlling the requests, the script uses a random timer before requesting a next item. This sets the lower boundary for this random time value. You should at least give it a second.
  /outputxdccinfo 12Set maximum delay for next queue item request:5 To simulate a human being controlling the requests, the script uses a random timer before requesting a next item. This sets the lower boundary for this random time value. You should at least give it half a minute.
  /outputxdccinfo 12Set minimum delay for re-request item on queue full:5 If a server sends you a notice that it has no queue spots available, the script will automatically re-request the pack on a random timer. This sets the lower value for that timer. It can be set no lower than 10 seconds. 
  /outputxdccinfo 12Set maximum delay for re-request item on queue full:5 If a server sends you a notice that it has no queue spots available, the script will automatically re-request the pack on a random timer. This sets the upper value for that timer. It can be set no lower than 10 seconds. It is recommended that you set this no lower than 300 seconds.
  /outputxdccinfo 12Set minimum delay for re-requesting file on no new connection demand:5 If a bot owner pauses a bot for a number of minutes, this part of the script will auto re-request the file after that number of minutes, plus a random offset. This is the minimum setting for that offset.
  /outputxdccinfo 12Set maximum delay for re-requesting file on no new connection demand:5 If a bot owner pauses a bot for a number of minutes, this part of the script will auto re-request the file after that number of minutes, plus a random offset. This is the maximum setting for that offset.
  /outputxdccinfo   
  /outputxdccinfo 12Set offset time for auto resume at start:5 This offset is primarily used to make sure the appropriate channels have been joined before sending the trigger for autoresume. A random delay is added to it that lies in the same range as that of the normal item resume request.
  /outputxdccinfo 
  /outputxdccinfo 10For all these values goes:5 the bigger the interval between min and max, the less likely that you'll be detected. Choose your own preference or use the default values.
  /outputxdccinfo 
  /outputxdccinfo 12Set delay offset for auto resume SEND reactivation:5 When resuming a failed DCC Send the auto-resume send script is temporarily disabled to prevent resends to an unwilling recipient (either because the connection is bad, or the recipient cancelled the file twice). Mostly, this would be caused by a recipient that continually times out, that has a full harddisc, has a corrupted upload part or who keeps cancelling the transfer, so this value should be set no lower (and preferably somewhat higher, just to be safe) than your DCC Send timeout value.
  /outputxdccinfo 
  /outputxdccinfo 12Set maximum delay for auto resume SEND:5 This time value will be used as the pause between a send fail and the next retry (the minimum for this is always 0, since send resume scripts will be less likely to be noticed or disliked by bot owners). A resend will be bandwidth-limited according to your settings.
  /outputxdccinfo 
  /outputxdccinfo 12Set delay for updated packfile comparison:5 This time value should be chosen with care: choosing it too low can cause the comparison to be made while listing is still in progress, causing false pack changed reports, whereas choosing it too high may render the function pointless because the wrongfull transfers may already have commenced, or the packfile may have scrolled by more than once, resulting in a pointless comparison. Note that the checker is not perfect, and it can sometimes overlook changes or report a change where none was made. It has been greatly improved since it's original implementation though.
  /outputxdccinfo 
  /outputxdccinfo 5*****************************************************************************
  /outputxdccinfo 
}
;-------------------------------------------------------------------------
;-------------------------------------------------------------------------