Skip to content

Environment Variables for plugin sdk

Dmitry edited this page Jan 1, 2018 · 10 revisions

The plugin-sdk Environment Variables are used to locate all components that are required for compilation.

Variable Name Description Default
PLUGIN_SDK_DIR Folder of plugin-sdk D:\Projects\plugin-sdk
GTA_SA_DIR GTA San Andreas folder D:\GTASA
GTA_VC_DIR GTA Vice City folder D:\GTAVC
GTA_III_DIR GTA 3 folder D:\GTA3
DIRECTX9_SDK_DIR Folder of DirectX 9 SDK (include and library folder locations from DirectX 9) D:\Projects\DXSDK\9.0
RWD3D9_DIR Folder of rwd3d9 (libs and source folders for the DirectX 9 addon for either GTA 3 or GTA Vice City) D:\Projects\rwd3d9
CLEO_SDK_SA_DIR Folder of CLEO SDK for GTA SA (folder which includes the files cleo.h and cleo.lib) D:\Projects\CLEO\sa\cleo_sdk
CLEO_SDK_VC_DIR Folder of CLEO SDK for GTA VC (folder which includes the files cleo.h and cleo.lib) D:\Projects\CLEO\vc\cleo_sdk
CLEO_SDK_III_DIR Folder of CLEO SDK for GTA 3 (folder which includes the files cleo.h and cleo.lib) D:\Projects\CLEO\iii\cleo_sdk
MOONLOADER_SDK_SA_DIR Folder of MoonLoader module SDK (folder which contains "src" folder) D:\Projects\ moonloader_module_sdk

To build the plugin-sdk and projects that use the plugin-sdk, you need to create a special environment variable called PLUGIN_SDK_DIR. For any projects that use the DirectX 9 SDK you need to set the DIRECTX9_SDK_DIR environment variable (and for GTA Vice City and GTA 3 - there is the variable RWD3D9_DIR). Any projects that use CLEO require the presence of the CLEO_SDK_SA_DIR (for GTA San Andreas), CLEO_SDK_VC_DIR (for GTA Vice City), CLEO_SDK_III_DIR (for GTA 3) environment variable. Any other variable is not mandatory.

Environment variables for plugin-sdk can be configured in the plugin-sdk installer.

To add an Environment Variable to your system manually, follow these steps:

  1. Go to Control Panel > System and Security > System
  2. Click on Advanced System Settings > Environment Variables...
  3. In either the Systemvariables or Uservariables click New...
  4. Put in the variable value (actually the approprivate path) and click OK

Be careful that you do not put trailing slashes (e.g. C:\WINDOWS\) into the variables.

Also, if you use Code::Blocks, do not use paths with spaces in plugin-sdk environment variables.