View source for OgreOther:AutoLogin

== Overview == 
OgreAutoLogin can open sessions, and/or use existing sessions, and log characters into specific sessions.

Note: This is an advanced feature. You will need to follow specific instructions, including creating windows short cuts to be able to set this up.

Remember: If you only want to auto login one character, all you need is to complete the "Before You Begin" section.  Then launch EQ2, open the innerspace console (using the ~ key), and type "oger login toonname" (without the quotes).

==Before You Begin==
In order to use OgreAutoLogin, you need the following set up prior.
* A blank loginscene. Information on obtaining one can be found in the [[NewUserWalkthrough:Page1|New user walkthrough page 1]]. (Scroll down to the section titled <b>Blank loginscene</b>)
* EQ2Chars.inc must be filled in with correct information. Information can be found in the [[NewUserWalkthrough:Page2|New user walkthrough page 2]].

== Step By Step ==
#MAKE SURE you have completed the "Before You Begin" section! DO NOT SKIP ANY STEPS on EITHER of the pages linked above, or the rest of this will NOT work.
#Locate and edit the following file - Innerspace/Scripts/EQ2OgreCommon/OgreAutoLogin/AutoLogin.iss. Here is a listing of the first few lines of that file:<br />
#:<code>******** Ogre Automated Login. Version 1.03 **********</code>
#:<code>Change the below 2 to match what you have. Below are the defaults. All computers must have the same names. Use uniformity.</code>
#:<code>variable string GameName="Everquest 2"</code>
#:<code>variable string ProfileName="Everquest 2 Default Profile"</code>
#:<code>Below is the amount of time the script will wait after it loads a session.</code>
#*Edit the <b>GameName</b> and <b>ProfileName</b> to match the values you used when you configured Innerspace.
#*If you are unsure of what your game name is you can right click the innerspace taskbar notification window
#:[[image:IS.taskbar.png]]
#*At the top, you'll see a list of the "GameNames" innerspace knows about.
#*Moving your mouse over the Everquest2 game will show the name of the "ProfileName" you need to use.
#*Use these exact names (case sensitive) when editing your AutoLogin.iss file.
#Create a Desktop Shortcut that will launch the Ogre Auto Login UI
#*Right-click on your desktop and click 'New' -> 'Shortcut'
#*Click the Browse... button to locate Innerspace/Innerspace.exe. This will put the path to Innerspace.exe in the "Type the location of the item:" box.
#*Edit that line to append "runscript eq2ogrecommon/OgreAutoLogin/AutoLogin" after the path to the exe.
#*The line should now look something like<br />
#:<i>D:\Games\InnerSpace\InnerSpace.exe runscript eq2ogrecommon/OgreAutoLogin/AutoLogin</i><br />
#::or<br />
#:<i>"C:\Program Files\Innerspace\InnerSpace.exe" runscript eq2ogrecommon/OgreAutoLogin/AutoLogin</i><br />
#:(if the path to Innerspace.exe contains spaces or special characters, you'll need quotes around the path as shown in the 2nd example)
#*Click the Next button, Give it a name and click Finish. 
#Launch the Ogre Auto Login UI by double-clicking the desktop shortcut you just created.
#* Note: This loads INSIDE of the uplink console. Depending on your computer, it will pop up in front of you, OR you will see a new window in your task bar, go ahead and click it. If you can't find the window anywhere, right-click the Innerspace icon in your taskbar and select Console.
#:[[image:Console.autologin.png|500px]]
#*The Character List (on the left) will contain all your characters from the EQ2Chars.ini file you edited above.
#**Select the first Character from Character List
#**Select the PC you wish to use for this character.
#**Select the Innerspace Session name to use for that character (e.g. IS1).
#*** Currently it performs the following checks
#**** If session is "Any"
#***** Toon will stay logged in on its current session
#**** If Session is specific "IS1" / "IS2" etc
#***** If toon online: Checks to see if the toon is on that specific session. If not, log off.
#***** If toon offline: If that specific session is in use, log that session off.
#**** If an alt (based off of eq2chars.inc list) is logged on, they will be logged off to allow the characters you have selected to be logged on.
#**Click Add Selection
#**Repeat for each character in the group you wish to have logged in at the same time.
#*Type in a name to save the profile as (on the right side), then click the Save Profile button.
#**The next time you run Ogre Auto Login UI, the saved profiles will be available under the "load profile" button.
#*Click 'Load Toons and exit'.
#*Wait for it to finish logging in all your toons (this can take a long time, even as much as a few minutes) then you can click 'X' to close the Innerspace Console.
#And you've now successfully set up and used Ogre Auto Login. You can just click your desktop shortcut any time you want, and it will launch the Ogre Auto Login UI (remember it might be in the background, or you might have to manually launch the Innerspace Console if your shortcut doesn't bring the window up automatically)<br />If you are happy with this, you can stop now. If you'd like to get even fancier, read the section below on launching a specific toon list directly from a desktop shortcut (without launching the Ogre Auto Login UI).

== Loading a specific toon list profile ==
Once you have created a toon list profile using the step-by-step method above, you can automatically launch and login that profile using Ogre Automated Login, rather than using the UI.
* The AutoLogin script that your desktop shortcut runs can accept 1 parameter, a saved toon list profile. When a parameter is passed, it automatically runs the script in the background, bypassing the Ogre Auto Login UI entirely.
* IMPORTANT *** You MUST create the toon list profile using the Ogre Auto Login UI *BEFORE* you can use this
#Let's assume you saved your toon list profile as "MainGroup".
#Create a new Desktop Shortcut exactly like you did above.
#When you get to the part where you're appending to the Innerspace.exe path, also append "MainGroup" at the very end.<br />Example:
#* <code>D:\Games\InnerSpace\InnerSpace.exe runscript eq2ogrecommon/OgreAutoLogin/AutoLogin MainGroup</code>
#Now you have two desktop shorcuts. The first one will launch the UI, and the second one will automatically log in your "MainGroup" toons, but will bypass the UI.

== Quirks == 
* It's a good idea to have Innerspace running before you double-click your desktop shortcuts. Double-clicking your shortcuts will launch Innerspace if it is not already running. However:
** If Innerspace needs to patch, it will do so, reload itself, and run the script you were trying to run, but it will not include any parameters you were passing in (i.e. the "MainGroup" toon list profile name.
** If Innerspace is already open, it simply runs the script with the parameters (which is a good thing).
* There is VERY limited user error checking. So use some common sense. For example: If you say you want the toon Kannkor to load on IS8 and that's it, it will load 1 session (IS1), and fail to load Kannkor because it can't find IS8. It's best to start to have the entire set (Kannkor IS1, Kannkor2 IS2 etc), or use the "Any" option.
* The odd time, when changing toons around, 1 session would crash. I can't reproduce this bug other than rarely, and randomly, so I believe it still exists. If this happens to you, look at the uplink console of that computer, and you should see a line such as: Command given: ogre -<stuff>-. I need the <stuff>. It will have your toon name, but if it has anything else (including spaces) I need to know exactly what that other stuff is.
* Note: When you run this, it loads ISXOgre into your uplink. Which should patch ISXOgre fine. However if you are in the game and need to patch ISXOgre, you will need to unload the extension from the uplink console (done via loading the console and ext -unload isxogre).

== Using Multiple Computers ==
If you are using multiple computers, you must have them "connected" prior to running your desktop shortcuts.
Connecting via shortcut example (this is the same as clicking connect on OgreMCP):
* D:\Games\InnerSpace\InnerSpace.exe runscript eq2ogrecommon/ogreconnect
* When using this shortcut, "nothing" visually you can see will happen. It simply connects your computers.
*'''Ensure all computers are using the same naming in the game profile in Innerspace game configuration.'''