Skip to content

player's command arguments

Jimmy Yin edited this page Aug 11, 2016 · 2 revisions
usage: /path/to/player -workdir /path/to/project

options:
    -workdir [path]            set work directory
    -writable [path]           set writable path (default: same as workdir)
    -file [path]               set lua star script file (default: scripts/main.lua)
    -landscape                 set frame size with 960x640
    -portrait                  set frame size with 640x960
    -size [wxh]                set frame size, width x height
    -scale [scale]             set window scale factor (default: 1.0)
    -write-debug-log           enable write debug log (default: disable)
    -disable-write-debug-log   disable write debug log
    -console                   show console ui (default). It is helpful but causes performace issue
    -disable-console           dont show console ui
    -load-framework            load precompiled framework (framework.zip)
    -disable-load-framework    dont load precompiled framework
    -offset [{0,0}]            set window bottom left position
    -resize-window             let window resizable

examples:

    # load project
    player -workdir /path/to/project

    # load project with portrait
    player -workdir /path/to/project -portrait

    # test with difference window size
    player -workdir /path/to/project -size 400x800

    # load project without console ui
    player -workdir /path/to/project -disable-console

log file path: [[workdir]]/debug.log

Clone this wiki locally