command_line.rst 1.7 KB

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