[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.4.2.1 Microsoft Visual C++ 6

Philip Wyett philipwyett@dsl.pipex.com. Last updated 25 June 2003.

In order to successfully compile the Crystal Space 3D Software Development Kit (SDK), you will need a copy of Microsoft Developer Studio 6 or the stand alone version of Microsoft Visual C++ 6, with additionally Service Pack (SP) 5 installed.

Getting Extra Help

If you need help with Crystal Space and Visual C++ or just Crystal Space in general. You can subscribe and then post a message to the Crystal Space mailing list. To subscribe see the following site and fill in the form:

http://lists.sourceforge.net/lists/listinfo/crystal-main

Required/Optional External Libraries and Software

All the following libraries and Software Development Kits (SDK) unless stated are not required. However, if you choose not to install them, at compile time you must follow the documented instructions of how to unload these projects from the Crystal Space build process.

msvc_libs - Required

Before you attempt to compile Crystal Space, you must download and install the "msvc_libs" archive. This archive contains alot of the third party header, pre-built libraries and dll files used by Crystal Space, i.e. `zlib.dll', `libjpeg.dll', `png.dll', etc. The latest version of this archive can be downloaded from:

msvc_libs with Python 2.2.3 debug components.

ftp://ftp.sunsite.dk/projects/crystal/support/win32/msvc_libs_0.97dev006_py223.zip

msvc_libs with Python 2.3.0 debug components.

ftp://ftp.sunsite.dk/projects/crystal/support/win32/msvc_libs_0.97dev006_py230.zip

Once you have downloaded the msvc_libs package, extract it too your `CS\' root directory.

DirectX - Required

In order to compile Crystal Space at its minimum i.e. the software render, requires you must have at least some form of the DirectX Software Development Kit (SDK) on your system.

Visual C++ 6 comes with the minimum DirectX SDK 5 files in-order to build Crystal Space.

To enable you to build Crystal Space to it's optimum D3D support, you must download the latest DirectX Software Development Kit (SDK), which can be obtained from:

http://www.msdn.microsoft.com/directx

If you are unable to accomplish the 200+Mb (For the full SDK) or 43Mb (For the VisualC only parts of the SDK) download of the DirectX 9 SDK from the link above. You can obtain cut down older versions (6 & 7 with no documents or example code) of the DirectX SDK's from the following website:

http://www.multimania.com/noote/CrystalSpace

Thanks, to the miracle which is Microsoft. If you download and install the latest DirectX 8a Software Development Kit (SDK) and already have Visual C++ installed, it will ask you if you wish to add the paths to the SDK to Visual C++ so it can use it. We recommend you accept when offered this option. If it is not the latest SDK you install you will have to manually point Visual C++ to where you installed the SDK in-order for it to be used. This can be done from the Visual C++ file menu and selecting Tools->Options->Directories. You must add the paths for both the include files and libraries and being that we wish Visual C++ to see and use this new SDK before all possible others on your system, you must click on and drag both paths you have entered to the top of the list.

Simple Direct Media Layer

Crystal Space contains support for a Simple Direct Media Layer 2D canvas which can be used as an alternative to the default Direct Draw canvas for use with the Crystal Space software 3D renderer. To compile the SDL2D canvas you must have the supported 1.2.3 development runtime for your version of MSVC be it 5 or 6. Please remember to add the `include' and `lib' directories to the global MSVC options, so MSVC can see them.

http://www.libsdl.org

Also remember to copy the `sdl.dll' into the `CS\' root directory or add it to your systems path before using the SDL2D canvas.

For instructions on using a specific canvas including the SDL2D canvas 3.1 Common Command Line Options

Python

Crystal Space contains support for Python scripting and thus has projects within it requires that Python be installed on your system. Make sure you add the Python include and libs directories too MSVC so that the compiler can see those files. If you wish to compile with Python support you must install Python 2.2 or later, which can be obtained from:

http://www.python.org

NOTE: To have parity with one of the latest versions of msvc_libs and take full advantage of the debug elements - you should have Python 2.2.3 or 2.3.0 installed on your system. Whichever version you decide to use, make sure you download the comparable msvc_libs.

Creative EAX 2.0

In order to build the CS EAX 2.0 environmental audio plugin (plgsndrdreax), requires you have the EAX 2.0 SDK on your system. The SDK can be obtained from the following website.

http://developer.creative.com/LEFTMENU/DC_LM_Downloads.asp

After installation you will need to point MSVC to the SDK's include and lib paths.

Compiling Crystal Space

To compile Crystal Space, you'll have to perform the following steps. If anything doesn't work, see the Win32 FAQ, MSVC6 FAQ.

  1. Load `CS\mk\visualc\csall.dsw'.

  2. Remove all projects you don't want to compile. To do this, right-click on the project in the list and select Unload Project. Examples of projects which you don't want to compile might include `plgopengl' if you do not have the OpenGL SDK installed, or `plgcspython' if you do not have the Python SDK installed.

  3. Make `grpall' your active project. This is done by right clicking on it and then clicking on Set as Active Project.

  4. From the file menu select Build->Rebuild All or alternatively hit your F7 key.

  5. After a while the compilation should finish without error. The signal for a successful build will be come in the form of the something similar to the following:

     
    ------------ Configuration: grpall - Win32 Debug ------------
    
    grpall.lib - 0 error(s), 0 warning(s)
    

Running the Demonstration Applications

The first app you should try is Walktest. This program shows many of the features of the 3D engine. You can run it by starting it from the windows explorer. It should be at `.../cs/walktest.exe'. Don't start it from other locations or from within Visual Studio. It won't find the required files if you do.

If you want to run a debug session, you first have to set the working directory. Open Project/Settings, select the appWalktest project, switch to the Debug tab and enter the base `CS\' directory as the working directory for debug sessions (for example, `C:\CS\'). Be sure to to this for Debug and Release builds.

You can now continue with the next platform-independent step. The remaining Windows-specific sections are only important when you want to compile your own application using Crystal Space.

Structure of the Workspace

Note: If you find bugs in the MSVC project or workspace files coming with Crystal Space, don't send fixes for these files to the developers. These files are generated automatically, so your fixes would be useless. Better, send a description of the bug to the mailing list.

The Crystal Space workspace is divided into several projects. They all exist as separate project files (`*.dsp'). All of them are being bound together by a workspace `csall.dsw'. This workspace will also ensure correct linking between the various projects.

The workspace uses a prefix system for naming the projects and grouping them. There are currently four prefixes in use. The prefix `grp' is used to group the projects into the three main categories: libraries, plug-ins, and applications. There is also a special group `grpall' that contains the three major groups `grplibs', `grpapps', and `grpplugins'.

The Libraries are C++ libraries that you can link into your own programs. Some of these libraries are part of the core of Crystal Space. You can find more information about this in 6. Libraries. Their output are `.lib' files.

The Plugins are also programming libraries, but they use a special mechanism called SCF as their interface to your program. This separates their interface from the internals of the library and thus allows dynamic linking. In fact, some of the Libraries also use SCF. The rule for the MSVC workspace is simple: The Plugins are projects that build a dynamic library (`.dll'). You can find more information in the section of this manual dealing with plug-in modules. See section 7. Plug-In Modules and Drivers.

The Applications are programs using some of these libraries, so they produce `.exe' files.

Compiling Your Own Program Using Crystal Space

It is assumed that you have set up MSVC projects before. If you want to create a project using Crystal Space, you have two possibilities how to do this: You can either create the project inside the Crystal Space workspace, or you can create a new workspace. Either way, you have to do the usual setup, like adding the source files. In addition to this, you must perform the following steps.

Frequently Asked Questions (FAQ)

This is the list of frequently asked questions for the Win32 port of Crystal Space. Please consult this list if you are having difficulty building or using the project.

Compilation

Linking

OK, now it should link. So you should have an executable file called `walktest.exe' in your src directory. Let's run it!

Executing

Miscellaneous


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

This document was generated using texi2html