README.md

   1 Torque 3D v3.5.1 - PhysX 3.3 Basic Plugin
   2 ==========================
   3
   4 This is a basic PhysX 3.3 plugin that does not contain any added features like cloth,particles and CCD. This plugin provides no more features than the bullet plugin and can therefore be used as a drop in alternative. It does not modify any files outside of the physx3 folder. A far more advanced physx3 plugin with CCD, cloth and particles can be found on this repository under the physx3 branch.
   5
   6 Setting up PhysX 3.3 using the Torque 3D Project Manager
   7 ------------------------------------------
   8  - You can find a pre compiled binary of the Torque3D Project Manager that supports PhysX 3.3 here: http://www.narivtech.com/downloads/T3DProjectManager-2-1-devel.zip and source code here: https://github.com/rextimmy/Torque3D-ProjectManager/tree/development
   9  - For the Project Manager to find PhysX 3.3 SDK you have two options 1)Create an environment variable called TORQUE_PHYSX3_PATH and have that pointing to the location you installed the SDK 2)Place the SDK into a folder called "Program Files"/NVIDIA Corporation/NVIDIA PhysX SDK/v3.3.0_win
  10  - Simply choose PhysX 3.3 physics from the modules list in the project manager and everything should be automatically taken care of.
  11
  12 Setting up PhysX 3.3 manually
  13 ------------------------------------------
  14
  15  - You will need the latest SDK from NVIDIA. This requires signing up for their developer program. If you don't already have access to their developer site then sign up now as access is not immediate.
  16  - Set up a standard Torque3D project, don't include any PhysX or Bullet, just regular Torque Physics in project manager options (if you're using it)
  17  - Generate Projects and open the source code in Visual Studio ( or the IDE of your choice )
  18  - In the solution explorer in the DLL for your project you should find Source Files -> Engine -> T3D -> physics
  19  - Add a new filter "physx3" and then right click on it and add existing item
  20  - Add all the files found under Engine\Source\T3D\physics\physx3\
  21  - Now you need to add the PhysX SDK.
  22  - Under the properties for the DLL project, under Linker -> Additional Library Directories add the lib\win32 directory for the PhysX 3.3 SDK. For example, mine is in: C:\Program Files (x86)\NVIDIA Corporation\NVIDIA PhysX SDK\v3.3.0_win\Lib\win32
  23  - In the same window under C/C++ you should see Additional Include Directories, you need to add the Include directory for the PhysX 3.3 SDK. For example, mine is in: C:\Program Files %28x86%29\NVIDIA Corporation\NVIDIA PhysX SDK\v3.3.0_win\Include
  24  - You should now be able to compile now without any issues.
  25
  26 The following libraries will also be needed:
  27
  28 Release , Debug
  29
  30  - PhysX3_x86.lib,PhysX3CHECKED_x86.lib
  31  - PhysX3Common_x86.lib,PhysX3CommonCHECKED_x86.lib
  32  - PhysX3Extensions.lib,PhysX3ExtensionsCHECKED.lib
  33  - PhysX3Cooking_x86.lib,PhysX3CookingCHECKED_x86.lib
  34  - PxTask.lib,PxTaskCHECKED.lib
  35  - PhysX3CharacterKinematic_x86.lib,PhysX3CharacterKinematicCHECKED_x86.lib
  36  - PhysXVisualDebuggerSDK.lib, PhysXVisualDebuggerSDKCHECKED.lib
  37  - PhysXProfileSDK.lib, PhysXProfileSDKCHECKED.lib
  38
  39 With debug build feel free to change CHECKED to DEBUG if you prefer but it will still require the CHECKED dll's though.
  40
  41 Running a project
  42 =======
  43 * [Complete Torque 3D 3.5.1 zip package](http://mit.garagegames.com/Torque3D-3-5-1.zip) with updated TorqueScript documentation, the *Project Manager*, and compiled versions of the templates.
  44 * [Torque 3D Project Manager v2.1](http://mit.garagegames.com/T3DProjectManager-2-1.zip) on its own for use in your T3D forks.
  45
  46 If you're looking for an older release see the [Torque 3D Archive](https://github.com/GarageGames/Torque3D/wiki/Torque-3D-Archive)
  47
  48 Creating a New Project Based on a Template
  49 >>>>>>> GarageGames/development
  50 ------------------------------------------
  51
  52  - To run a release project you will need the following from the SDK bin folder:
  53    1. PhysX3_x86.dll
  54    2. PhysX3CharacterKinematic_x86.dll
  55    3. PhysX3Common_x86.dll
  56    4. PhysX3Cooking_x86.dll
  57
  58  - To run a debug project you will need the following from the SDK bin folder:
  59    1. PhysX3CHECKED_x86.dll
  60    2. nvToolsExt32_1.dll
  61    3. PhysX3CookingCHECKED_x86.dll
  62    4. PhysX3CommonCHECKED_x86.dll
  63    5. PhysX3CharacterKinematicCHECKED_x86.dll
  64
  65 Place these files along side the exe and this should get you up and running.