nel/tools/3d/plugin_max/compilation_notes_vc7.txt

   1 ******************************************************************
   2 * NeL plug-ins for 3DSMAX 4.2 + MSVC.NET (VC7) compilation notes *
   3 ******************************************************************
   4
   5
   6 ** DISTRIBUTION NOTES **
   7
   8 Given that Max plug-ins are linked to the 3DSMax SDK (which is not Gnu GPL)
   9 and to NeL (which is Gnu GPL), anyone distributing plug-ins in binary form will be in
  10 breach of the Gnu GPL.
  11
  12 In English than means that you shouldn't distribute the plug-ins as binaries.
  13 You are, of course, free to distribute the source code.
  14
  15 THIS PLUGIN HAVE BEEN TESTED ON 3DSMAX3.1 WITH CHARACTER STUDIO 3.
  16
  17
  18 1. Max/MaxSDK setup
  19    ----------------
  20
  21 You must install the MaxSDK on your machine. Let's say that <Maxpath> is the
  22 installation path of your 3DSMax software. You must add the following C++
  23 paths from the global settings of VC7 (Tools/Options/Projects/VC++ Directories):
  24
  25   Library files : <Maxpath>\Lib
  26   Include files : <MaxPath>\Include
  27                   <MaxPath>\Include\Maxscrpt
  28
  29 Due to a conflict between a NT's include file and a Maxscript one (<parser.h>),
  30 you must insert the Max include files BEFORE any reference to the PlatformSDK
  31 includes.
  32
  33 Upon compilation, the plugins and needed DLLs will all be output in the
  34 'code/nel/lib7/' folder. Update your <Maxpath>/plugin.ini file to add a this
  35 plugin path. Example :
  36
  37   [Directories]
  38   Standard MAX plug-ins=C:\3dsmax42\StdPlugs
  39   Additional MAX plug-ins=C:\3dsmax42\plugins
  40   NeL plug-ins=C:\nel_cvs\code\nel\lib7
  41
  42 Finally, you'll have to install some startup scripts. They reside in the
  43 'code/nel/tools/3d/plugin_max/script/startup/' folder, and they have to be
  44 copied in '<Maxpath>/scripts/startup'.
  45
  46 Note (2002/08/07) :
  47   nel_material.ms and nel_multi_set.ms do not run well under Max4.2 for
  48   now, you should currently ignore them (don't copy them).
  49
  50
  51
  52 2. Compilation
  53    -----------
  54
  55 Open 'code/nel/tools/3d/plugin_max/plugin_max_public.sln'. It will build
  56 several targets, along some NeL dependencies. You should see the following
  57 files in 'code/nel/lib7/' :
  58
  59 (Shared components :)
  60   nel_3dsmax_shared<suffix>.dll
  61   object_viewer.dll
  62 (Max plugins :)
  63   nelexport.dlu
  64   neltileutility.dlu
  65   nelconvertpatch.dlm
  66
  67 The <suffix> part depends on your build profile ('rd' for ReleaseDebug, 'df' for
  68 'DebugFast', etc).
  69
  70
  71
  72 3. Runtime
  73    -------
  74
  75 In order that all DLL can be found at load time, update your PATH environment variable
  76 to add the full name (ie. including the drive letter) of your 'code/nel/lib7/' path.
  77
  78   NT/2K/XP users : Config Panel/System/'Advanced' tab/'Environment variables' button.
  79   PATH should be defined in the global variables. You don't have to reboot, but you must
  80   restart the current running applications in order they notice this change.
  81
  82   Win95/98/Me users : edit your PATH in C:\AUTOEXEC.BAT, then reboot (no alternative).
  83
  84 Last step : the object viewer needs a config file at runtime, use the one provided with
  85 the distribution. Copy 'code/nel/tools/3d/object_viewer/object_viewer.cfg' into your
  86 'code/nel/lib7/' path (side by side with the Max plugins). You may edit it as fit.
  87
  88
  89
  90 4. Simple test
  91    -----------
  92
  93 Launch 3DSMax. It should load the nel_* startup scripts and maybe generate some errors
  94 due to Maxscript differences between 3.x and 4.x. You can 'safely' ignore them (for now).
  95
  96 Create a simple primitive, like a 'teapot' : select 'teapot' from the primitive tab
  97 on the right, then click on the viewport to place it and size it.
  98
  99 Select the 'tool tab' (little hammer, rightmost), click the 'More' button. The dialog
 100 should show a list of plugins, 'NeL Export' and 'NeL Tile Bank' being among them. Select
 101 'NeL Export'.
 102
 103 Now click on the 'View scene' button in the bottom right panel. You should see the
 104 object viewer popup with a gray teapot. Max navigations shortcuts are available
 105 (Ctrl/Alt + middle mouse button, etc).
 106