

===========================
  prophecy 3d sdk
  win32 configuration
  author: jukka.liimatta@twilight3d.com
===========================

After decompressing the prophecy???.zip archive into the targer folder, for example prophecy3d/, it is time to configure the development environment. The default environment under the windows operating system we use is the Microsoft Developer Studio 6.


===========================
  setting up the paths
===========================

In the Developer Studio, go to the "Tools -> Options" menu, where select the "Directories" tab. The following categories must be setup with the following values:

INCLUDE: prophecy3d/
LIBRARY: prophecy3d/lib/win32vc6/
EXECUTABLE: nasm/

The "prophecy3d/" means the folder where user extracted the SDK archive. The "nasm/" is the folder where NASM ( NetwideAssembler ) utility is installed. This assembly compiler is required in order to compile the x86 native implementation files under windows.

The NASM can be found from the web: http://www.web-sites.co.uk/nasm/  -- please kindly let us know if the website moves, and we will reflect the change in this document.


===========================
  compiling the libraries
===========================

After the developer studio paths are configured, it is time to build the libraries. Workspaces are provided for the MSVC++6 compiler-- under each library, there is build/win32vc6/ folder where the respective workspace can be found.

The libraries the user must compile:

prcore.lib
primport.lib
prmath.lib

The SDK should come with pre-compiled retail libraries. The debug libraries must be manually compiled. To make compiler more straightforward, workspace is provided which compiles all the libraries with one keystroke: lib/win32vc6/prophecy3d.dsw


===========================
  console examples
===========================

First thing to setup a console compiling, is to add prophecy into the include and lib paths. Here is a simple bat file to setup the environment variables, notice that the pr3d path must be edited to match where the SDK was installed.

[ prophecy.bat ]
@echo off
call vcvars32.bat
set prophecy=e:\mysdk\prophecy3d\
set include=%include%;%prophecy%
set lib=%lib%;%prophecy%lib\win32vc6
echo Prophecy SDK: online.

Under Windows NT and Windows 2000 the paths can be setup from the system menu as well. To compile the console examples, use the following commandline:

nmake.exe -f makefile.vc6

The examples should build, and link if all paths were setup correctly. 

Just in case the user is not familiar with commandline compiling, the above "prophecy.bat" is NOT mandatory to work with the prophecy sdk when using Developer Studio-- it has it's own internal settings, which were declared earlier in this document.




<eof>