Env_Dev.bat.example 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. @echo off
  2. REM
  3. REM Copyright (c) Contributors to the Open 3D Engine Project.
  4. REM For complete copyright and license terms please see the LICENSE at the root of this distribution.
  5. REM
  6. REM SPDX-License-Identifier: Apache-2.0 OR MIT
  7. REM
  8. REM
  9. echo.
  10. echo _____________________________________________________________________
  11. echo.
  12. echo ~ O3DE DCCsi Env Dev ...
  13. echo _____________________________________________________________________
  14. echo.
  15. echo ~ local env settings
  16. echo.
  17. :: developers can add temporary/custom envar settings
  18. set O3DE_BUILD_FOO=True
  19. echo O3DE_BUILD_FOO = %O3DE_BUILD_FOO%
  20. :: developers may have multiple repos, on different branch states
  21. :: this allows a dev to explicitly set the root engine path
  22. :: e.g. the nightly installer default is C:\O3DE\0.0.0.0
  23. :: set O3DE_DEV=C:\depot\o3de-dev
  24. :: the build folder for o3de binaries is not always known
  25. :: where it is in an installer release may be stable
  26. :: but for example, the nightly installer is pre-built and does not
  27. :: have a build folder location, just the binaries location
  28. :: C:\O3DE\0.0.0.0\bin\Windows\profile\Default
  29. set "O3DE_DEV=C:\depot\o3de-dev"
  30. :: engine developers may build in an engine centric way
  31. :: and configure a cmake build anywhere, this allows devs to set their
  32. :: build folder name (assuming it is in the engine root)
  33. set O3DE_BUILD_FOLDER=build
  34. :: this allows the full path to your build folder to be explicitly set
  35. :: this would work for also pointing to a project centric build location
  36. set "PATH_O3DE_BUILD=%O3DE_DEV%\%O3DE_BUILD_FOLDER%"
  37. echo PATH_O3DE_BUILD = %PATH_O3DE_BUILD%
  38. :: this is the path down from the build folder to binaries
  39. set "O3DE_BIN_PATTERN=bin\profile"
  40. :: this allows the full path to your bin folder to be explicitly set
  41. set "PATH_O3DE_BIN=%PATH_O3DE_BUILD%\%O3DE_BIN_PATTERN%"
  42. echo PATH_O3DE_BIN = %PATH_O3DE_BIN%
  43. :: this will enable additional debug behaviour within code
  44. :: this will in many cases cascade into settings like LogLevel
  45. :: note: expect things to become more verbose
  46. set DCCSI_GDEBUG=True
  47. echo DCCSI_GDEBUG = %DCCSI_GDEBUG%
  48. :: this generally enables behaviour such as auto-start/connect debugger in entry points
  49. :: or may enable local tests that execute during operation
  50. set DCCSI_DEV_MODE=True
  51. echo DCCSI_DEV_MODE = %DCCSI_DEV_MODE%
  52. :: This specifies the debugger to use for DEV_MODE
  53. :: note: currently only wing is supported (expanding this is future work)
  54. set DCCSI_GDEBUGGER=WING
  55. echo DCCSI_GDEBUGGER = %DCCSI_GDEBUGGER%
  56. :: even though you can enable/disable debug logic
  57. :: this allows the logging level to be explicitly set (more verbose)
  58. :: I commonly set this to 10 even when I disbale the global debug flag
  59. set DCCSI_LOGLEVEL=10
  60. echo DCCSI_LOGLEVEL = %DCCSI_LOGLEVEL%