History: The Complete Blanks Guide To Using The OGRE SDK AppWizard

            {maketoc}

!!Introduction
This is a brief, but detailed guide to use the OGRE SDK and the OGRE SDK AppWizard.

Remember: You don't need anything but Visual C++, the OGRE SDK and the AppWizard.

And you don't need to configure any project options. The wizard takes care of that.

If you run into problems using the wizard, please visit [http://code.google.com/p/ogreappwizards/|Ogre AppWizard on Google.code] or the [http://www.jacmoe.dk/forum/index.php?board=4.0|Ogre AppWizards Forum]

!!Get It
Get the OGRE SDK for your compiler : [http://www.ogre3d.org/download/sdk|Here]
Get the Microsoft DirectX Redistributable : [http://www.microsoft.com/downloads/details.aspx?FamilyID=04ac064b-00d1-474e-b7b1-442d8712d553&displaylang=en|Here]
Get the OGRE SDK AppWizard for your compiler : [http://code.google.com/p/ogreappwizards/downloads/list|Here]

Make sure that the AppWizard matches your version of the OGRE SDK!

!!Install It
!!!OGRE SDK
__Very important!__

Do not install this into a directory name with spaces in it, like "My Documents" or the like. You are only asking for trouble.

Choose a sensible no-spaces-in-it name, like ''{MONO()}C:\OgreSDK{MONO}''.

Install the OGRE SDK.

After installation, we are checking that everything is alright. We want the OGRE_HOME environment variable present, and we want it to point to where the OgreSDK is installed.

It happens by default, but we are checking anyway.

Right-Click the "My Computer" icon, go to the Advanced tab and click on the Environment Variables button.

{img src="img/wiki_up/Enviroment_vars.gif" alt="Enviroment_vars.gif"}

You should see an {MONO()}OGRE_HOME{MONO} environment variable pointing to your newly installed OGRE SDK.

!!!OGRE AppWizard
OK. Now unzip the OGRE AppWizard to somewhere safe.

!!!!Windows 95/98/2000/Me/XP
Jump into the folder, and find the installation script:

{img src="img/wiki_up/Wizard_install.gif" alt="Wizard_install.gif"}

Double-click on it.

Hopefully it is successful:

{img src="img/wiki_up/Wizard_success.gif" alt="Wizard_success.gif"}

Forget about this directory! You don't need to see it again, nor use it.

Just leave it where it is, alright? :-)

You will create new projects from Visual Studio, not from here.

!!!!Windows Vista / Windows Seven
Under Vista, you'll need to run a Command Prompt as administrator. 
You can do this by going to Start Menu/All Programs/Accessories, then right-clicking on Command Prompt and selecting Run as administrator.

Once the console windows open, navigate to the folder where the script is located, then type its name (eg.: VC8_setup), followed by Enter.

Once the confirmation window has popped, the setup should be finished. Leave the files where they are.

!!Use it
Now, it is time to fire up Visual Studio.

!!!Create a New Project
Create a new project:

{img src="img/wiki_up/New_project.gif" alt="New_project.gif"}

Locate the OGRE SDK Application Icon, and don't forget to give your project a name and a place to stay!

Again, you are advised to choose a no-spaces-in-it-path. :-)

{img src="img/wiki_up/SDKApp.gif" alt="SDKApp.gif"}

!!!Follow the Wizard
Click OK and watch the first page of the OGRE SDK Application Wizard:

{img src="img/wiki_up/Appwizard1.gif" alt="Appwizard1.gif"}

Go to the next page - make sure that the post-build copy is checked:
(If you are using the source, make sure the location is set to "'OGRE_SRC' environment variable" and that that environment variable is defined.)

{img src="img/wiki_up/Appwizard2.gif" alt="Appwizard2.gif"}

Click on "Finish" - and watch your new project:

{img src="img/wiki_up/Test1.gif" alt="Test1.gif"}

!!!Build your Project
Now, open the main source file of the project (''Test1.cpp'' in our case) and remove (or comment) the "''{MONO()}SET_TERM_HANDLER{MONO}''" line (should be line 39). This line isn't needed anymore.

You are now ready to build your project.

Build your project:

{img src="img/wiki_up/Test1_build.gif" alt="Test1_build.gif"}

Watch the output window for success:

{img src="img/wiki_up/Build_success.gif" alt="Build_success.gif"}

Notice that the exe is copied to the OgreSDK/bin/debug directory.

!!Run it
Go to your OgreSDK/bin/debug directory and find your creation:

{img src="img/wiki_up/New_creation.gif" alt="New_creation.gif"}

Run it goddamnit! (:biggrin:)

!!FAQ
!!!Upon executing, I receive the following error
If you run into problems running this, look at this guide:
((Visual Studio Debugging Settings - Shoggoth))

__OGRE EXCEPTION(7:InternalErrorException):Could not load dynamic libary .\Plugin_PCZSceneManager.dll. System Error: The specified module could not be found.__ 
__in DynLib::load at ..\src\OgreDynLib.cpp (line 80)__

Try deleting the following two entries from the Plugins.cfg file:

__PCZSceneManager.dll__
__OctreeZone.dll__

!!!The setup doesn't run when I double-click the '.js' setup file.
try adding this to the js extension under run. (In 'Folder Options' in File Explorer.)

{MONO()}~np~C:\WINDOWS\System32\WScript.exe "%1" %*~/np~{MONO}

(If this don't work you must specify the target script language with the flag __//E:jscript__ like 
__{MONO()}~np~C:\WINDOWS\System32\wscript.exe //E:jscript "%1" %*~/np~{MONO}__ )

or from the run box

{MONO()}C:\WINDOWS\System32\WScript.exe locationofsetupjs{MONO}

(If this don't work you must specify the target script language with the flag __//E:jscript__ like 
__{MONO()}C:\WINDOWS\System32\WScript.exe //E:jscript locationofsetupjs{MONO}__ )

__Note:__ If ''__WScript__'' fails, try using ''__CScript__'')

---
Alias: (alias(The_Complete_Blanks_Guide_To_Using_The_OGRE_SDK_AppWizard))