Q3Launch - A mIRC Add-on For Quake3:Arena Players
2000 -=Digit4l=- of -=Digital Oxygen=-
digit4l@planetquake.com
http://planetquake.com/q3launch


.:[HELP FILE]:.

1. Disclaimer
2. Quake3 Tab
3. Q3L Options Tab
4. IRC Options Tab
5. Settings Tab
6. Credits Tab
7. Other Info (Command Line)
8. FAQ

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

1. .:[DISCLAIMER]:.

   This addon is 2000 -=Digit4l=- of -=Digital Oxygen=-.
   I cannot be held resposible for anything this add-on may do in regards
   to the way that you use it. As written by the author, it will in no way
   harm your computer or current mIRC script, and it will not transfer any
   information that it should not. This includes your Quake3:Arena CDKey.
   Although this add-on will, if enabled, detect and report to your screen
   the CDKey for Quake3:Arena, it will not record this information for any
   longer than 2 seconds, and will not send this information anywhere.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

2. .:[Quake3 Tab]:.

   Here I will outline the various options and their functions within the
   script. This will be presented in point form.

   -=Favorite Servers=-
   This section allows a user to Add a favorite server for quick launch in
   mIRC, Edit/Delete a preset server, or Connect to a preset server all 
   available through the drop down box. If you decide to delete a favorite
   server however, it will only remove the setting, replacing it with info
   on using the Edit feature to replace it.

   -=Q3A Executable=-
   This section shows where your current Quake3 executable file is located.
   It is vital the the add-on working properly that this is set correctly.
   You may also change the current path to the executable by selecting the
   "Change" option.

   -=Specify=-
   Use this option to specify a server that you would like to connect to,
   without adding it to your favorites list.

   -=Default=-
   Use this option to simply load Quake3 as if you selected it's icon in
   Windows.

   -=MOD Launch=- .:[CURRENTLY DISABLED]:.
   This option will allow you to specify a Quake3 MOD to launch, and an
   optional server to connect to. Keep in mind the server MUST be running
   the same MOD in order for this to work.
   
   -=CDKey Scan=-
   Use this area to Enable or Disable the Q3Launch Quake3:Arena CDKey Scan
   feature. More information on this and it's security can be found in the
   readme file accompanying this add-on.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

3. .:[Q3L Options Tab]:.

   -=GameSpy Support=-
   This option will determine if you wish to allow GameSpy 3D integration
   within the script. Allowing integration will set a timer within mIRC
   to detect a file GameSpy creates when you connect to a server through
   GameSpy. If the timer detects this file, it will open the file, read
   the information contained within, set you away on IRC, and allow other
   users to issue a command to determine what game you are playing. Once
   the command is issued, this addon will reply to the user with the info
   it has detected so they may in turn connect to that server to commence
   playing the game with you. You can Enable or Disable this integration.

   -=GameSpy Installation Info=-
   Upon installation of the addon, you will be prompted for the correct
   path to your current GameSpy.exe file. The two options available here
   are "Launch" and "Change". Launch will open GameSpy 3D, and Change
   will allow you to change the current path to GameSpy 3D.
   NOTE: The option to 'Launch' will be included in a later version, most
   probably version 1.05 (next non-beta release).

   -=Update Check=-
   This will use mIRC sockets to query our Master Update server to see
   if you are running the latest version of this add-on or not. Even
   though we do open a direct connection from your computer to our server
   no information is sent from your computer to ours. Information is only
   queried from our server in the form of a single line containing the
   current version. There is no need for worry, but if some still exists,
   you can avoid using this feature and simply keep visiting our website
   to check for updates. Keep in mind also that this is only guaranteed
   to work as long as our server is operational. If at any time you check
   for an update, and the script replies there is a new version available
   but doesn't reply with the version number, an error has occured and the
   check failed. Try waiting 10 minutes and trying again.

   -=Uninstall=-
   This will remove all script variables present in mIRC pertaining to
   this add-on, and unload any files used. It will also delete the files
   the script uses to store your favorite server information, so it is
   advised to use the Backup feature (explained below) to retain your
   favorite server.

   -=Backup Option=- .:[CURRENTLY DISABLED]:.
   Use this feature to copy all script variables and settings to *.q3lbak
   files. This feature will be useful in a later version when I have made
   decoding and replenishing of these variables available. At the present
   time this feature is disabled.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

4. .:[IRC Options Tab]:.

   -=Auto-Away=-
   This feature will set you away when launching a Q3 server through the
   addon, or through GameSpy (if enabled). You will be set away if this
   option is enabled with the desired away message that you may also set
   below. Your away message will appear similar to the following:

   * Digi|Q3 is away -=[Fraggin' & Shaggin' In Q3:Arena @ 127.0.0.1]=-

   Depending on other options available here on this tab, your message
   may appear differently. That will be outlined below.

   NOTE: The following commands with the exception of the Channel Scan
         are only activated if you enable the Auto-Away feature.

   -=Nick Change=-
   With this feature enabled, when you are set away, your nick will change
   to the desired nick specified in the AwayNick option (outlined below).

   -=Scan Reply=-
   With this option enabled, you will allow users to query the information
   on your current game, such as server ip and port, via a ctcp command,
   in which the script will message them the information. The user will
   see the command they must use to activate the reply in the away message.
   With this option enabled, the message will appear similar to this:

   * Digi|Q3 is away -=[Fraggin' & Shaggin' In Q3:Arena @ 127.0.0.1]=-
   <Digi|Q3> Want The Server Info? Type: /ctcp Digi|Q3 Q3ServInfo

   Providing all of the information is set on this tab, the user will be
   queried in a message window with the information on the server ip, port,
   and your current nickname on that server.

   -=Away-Nick=-
   Type your desired nickname when set away in the box provided. This section
   is automatically updated as soon as you enter the nickname. The nickname
   you specify here will be the nickname people on IRC will see when you start
   a game using this script or GameSpy 3D (if enabled). Please note that on
   most IRC Networks (i.e. EFnet), you are limited to a 9 character nickname.

   -=Game Nick=-
   Set this to your current in-game nickname and when a user type the command
   to get the current information from you, it will also give them your game
   nickname so they will know who you are. As with above, this command is
   immediately updated as soon as you input the nickname. 

   -=Channel Scan=-
   Activating this command will input the command to scan the current channel,
   (yes, the entire channel) to see if there are users on that current channel
   who have this script installed and are currently playing Quake3. NOTE: You
   *may* receive error messages from other users due to this command being a
   ctcp command that is unrecognized by their current script. I will be trying
   to incorporate a new way to activate this feature, probably through a notice.

   -=Away Message=-
   Here is where you enter the text you wish to appear in your away message.
   Keep in mind that this section will work in conjunction with *most* (I say
   most because I have yet to test it with other scripts, but I can't see too
   many problems with most conventional scripts) scripts by taking advantage
   of mIRC's /away feature. Your away message will have the following three
   characters in it: -=[ . They will be reversed to finish the away message.
   Your away message will also contain the "@ IP" at the immediate end of the
   away message you have specified, with "IP" being the current server IP you
   have connected to.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

5. .:[Settings Tab]:.

   There is no configurable settings for this tab. Everything found here
   is self-explanitory.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

6. .:[Credits Tab]:.

   This tab lists the current Credits/Links that this add-on recognizes.
   Can't see your name there? Think you should be? E-Mail me to explain
   why you think you or your site should be there. You can also click
   the buttons provided to launch Internet Explorer and visit the sites.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

7. .:[Command Line Interpreters]:.

   The add-on currently has many command line interpreters, however there
   is only 6 of which would be of any use to you without resetting variables.
   For MOD options, where you see 'MOD', specify the MOD name to proceed, and
   for 'IP' in all options, specify the IP or Server Address to begin play.
   The options are as follows:

   /quake3           =-= This will launch Quake3 without connecting to a 
                         server.
   /quake3 IP        =-= This will launch Quake3 connecting the the specified
                         IP address. If the server has a specific port, use 
                         IP:port
   /quake3sm MOD     =-= This will launch Quake3 and start a single player 
                         game using a Q3A MOD.
   /quake3mm MOD IP  =-= This will launch Quake3 and start a multi player 
                         game using a Q3A MOD.
   /q3               =-= This will launch Quake3 without connecting to a 
                         server.
   /q3 IP            =-= This will launch Quake3 connecting the the specified
                         IP address. If the server has a specific port, use 
                         IP:port
   /q3sm  MOD        =-= This will launch Quake3 and start a single player
                         game using a Q3A MOD.
   /q3mm  MOD IP     =-= This will launch Quake3 and start a single player
                         game using a Q3A MOD.

   Since I do not personally run MODs, I have yet to be able to check for sure
   that these MOD options presented work properly. Feedback is wanted on this
   feature, and if successful, the next release will have a GUI for this option.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

8. .:[Frequently Asked Questions]:.

   None. This addon, now accompanied by this help file, should be self-
   explanitory. However, as I recieve questions on this, I will commit
   them to this file for later versions. So if you have any questions,
   don't hesitate to e-mail me at digit4l@planetquake.com for a quick
   response.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

EOF

Last Updated: Sunday, January 30, 2000 @ 2:51 AM
2000 -=Digit4l=- of -=Digital Oxygen=-
