command_line.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. Command line reference
  2. ======================
  3. ``-h`` ``--help``
  4. Display the help and quit.
  5. ``-v`` ``--version``
  6. Display engine version and quit.
  7. ``--source-dir <path>``
  8. Use <path> as the source directory for resource compilation.
  9. The <path> must be absolute.
  10. ``--data-dir <path>``
  11. Use <path> as the destination directory for compiled resources.
  12. The <path> must be absolute.
  13. ``--boot-dir <path>``
  14. Boot the engine with the ``boot.config`` from given <path>.
  15. The <path> must be relative.
  16. ``--compile``
  17. Do a full compile of the resources.
  18. When using this option you must also specify ``--platform``, ``--source-dir`` and ``--data-dir``.
  19. ``--platform <platform>``
  20. Compile resources for the given <platform>.
  21. Possible values for <platform> are:
  22. * ``android``
  23. * ``linux``
  24. * ``windows``
  25. ``--continue``
  26. Run the engine after resource compilation.
  27. ``--console-port <port>``
  28. Set port of the console.
  29. When no port is specified, the engine uses the port 10001.
  30. ``--wait-console``
  31. Wait for a console connection before starting up.
  32. ``--parent-window <handle>``
  33. Set the parent window <handle> of the main window.
  34. This option should be used only by the tools.
  35. ``--server``
  36. Run the engine in server mode.
  37. When using this option you must also specify ``--source-dir``.
  38. ``--run-unit-tests``
  39. Run unit tests and quit. Available only on ``linux`` and ``windows``.