Differences

This shows you the differences between two versions of the page.

--- user:player:command-line [2016/02/07 09:19] – Add new command line options carstene1ns
+++ user:player:command-line [2025/02/09 17:31] (current) – Command parameters on player web en.i
@@ Line 1: / Line 1: @@
 ====== Command Line Arguments =====
-All arguments must be prefixed with a double dash.
+This page could be outdated. Check https://easyrpg.org/player/manual/#_options for up to date command line documentation.
 ^Argument^Description^
-|''battle-test N''|Start a battle test with monster party N.|
+|''%%--%%battle-test N'' or ''BattleTest 'ID' ''|Start a battle test with monster party ''N''.|
-|''disable-audio''|Disable audio (in case you prefer your own music).|
+|''%%--%%disable-audio''|Disable audio (in case you prefer your own music, though you can just lower the volume to 0 in the settings since 0.8.0). Using this setting will cause the //Conditional Branch: BGM has completed a loop// to always be returned as false, and the command //Control Variables: Set MIDI tick// will count the number of seconds that have passed since the last time a new music has been played independently of the content of the file (note that speeding up the game will also speed up the progress of this value). Otherwise, works as expected.|
-|''disable-rtp''|Disable support for the Runtime Package (RTP).|
+|''%%--%%disable-rtp''|Disable support for the Run Time Package (RTP). Will lead to checkerboard graphics and silent music/sound effects in games depending on the RTP.|
-|''encoding N''|Instead of auto detecting the encoding or using the one in RPG_RT.ini, the encoding N is used. Use ''auto'' for automatic detection.|
+|''%%--%%encoding N''|Instead of auto detecting the encoding or using the one in RPG_RT.ini, the encoding ''N'' is used. Use ''auto'' for automatic detection.|
-|''engine ENGINE''|Disable auto detection of the simulated engine. Possible options: ''rpg2k'', ''rpg2k3'' and ''rpg2k3e''(english release).|
+|''%%--%%engine ENGINE''|Disable auto detection of the simulated engine. Possible options: ''rpg2k'' (RPG Maker 2000 engine, v1.00 - v1.10), ''rpg2kv150'' (RPG Maker 2000 engine, v1.50 - v1.51), ''rpg2ke'' (RPG Maker 2000 engine, English release, v1.61), ''rpg2k3'' (RPG Maker 2003 engine, v1.00 - v1.04), ''rpg2k3v105'' (RPG Maker 2003 engine, v1.05 - v1.09a) and ''rpg2k3e'' (RPG Maker 2003 engine, English release).|
-|''fullscreen''|Start in fullscreen mode.|
+|''%%--%%fullscreen''|Start in full screen mode.|
-|''show-fps''|Enable frames per second counter.|
+|''%%--%%show-fps''|Enable frames per second counter.|
-|''hide-title''|Hide the title background image and center the command menu.|
+|''%%--%%fps-render-window''|Render the frames per second counter in both full screen and windowed mode.|
-|''load-game-id N''|Skip the title scene and load SaveN.lsd (N is padded to two digits).|
+|''%%--%%fps-limit''|Set a custom frames per second limit. If unspecified, the default is 60 fps. Set to 0 to disable the frame limiter. This option may not be supported on all platforms.|
-|''new-game''|Skip the title scene and start a new game directly.|
+|''%%--%%no-vsync''|Disable vsync and use fps-limit. Vsync may or may not be supported on all platforms. Check the engine log to verify whether or not vsync actually is being used.|
-|''project-path PATH''|Instead of using the working directory the game in PATH is used.|
+|''%%--%%enable-mouse''|Use mouse click for decision and scroll wheel for lists.|
-|''save-path PATH''|Instead of storing save files in the game directory they are stored in PATH. The directory must exist. When using the game browser all games will share the same save directory!|
+|''%%--%%enable-touch''|Use one/two finger tap for decision/cancel.|
-|''seed N''|Seeds the random number generator with N.|
+|''%%--%%hide-title'' or ''HideTitle''|Hide the title background image and center the command menu.|
-|''start-map-id N''|Overwrite the map used for new games and use MapN.lmu instead (N is padded to four digits). Incompatible with ''load-game-id''.|
+|''%%--%%load-game-id N''|Skip the title scene and load SaveN.lsd (''N'' is padded to two digits).|
-|''start-position X Y''|Overwrite the party start position and move the party to position (X, Y). Incompatible with ''load-game-id''.|
+|''%%--%%new-game''|Skip the title scene and start a new game directly.|
-|''start-party A B...''|Overwrite the starting party members with the actors with IDs A, B, C... Incompatible with ''load-game-id.''|
+|''%%--%%project-path PATH''|Instead of using the working directory the game in ''PATH'' is used.|
-|''test-play''|Enable TestPlay mode.|
+|''%%--%%rtp-path PATH''|Adds ''PATH'' to the RTP directory list and use this one with highest precedence.|
-|''window''|Start in window mode.|
+|''%%--%%record-input PATH''|Records all button input to a log file at ''PATH''.|
-|''version''|Display program version and exit.|
+|''%%--%%replay-input PATH''|Replays button input from a log file at ''PATH'', as generated by --record-input. If the RNG seed (--seed) and the state of the save file directory is also the same as it was when the log was recorded, this should reproduce an identical run to the one recorded.|
-|''help''|Display this help and exit.|
+|''%%--%%save-path PATH''|Instead of storing save files in the game directory they are stored in ''PATH''. The directory must exist. When using the game browser all games will share the same save directory!|
+|''%%--%%seed N''|Seeds the random number generator with ''N''.|
+|''%%--%%autobattle-algo ALGO''|Which AutoBattle algorithm to use. Possible options are ''RPG_RT'' (The default RPG_RT compatible algo, including RPG_RT bugs), ''RPG_RT+'' (The default RPG_RT compatible algo, with bug fixes) and ''ATTACK'' (RPG_RT+ but only physical attacks, no skills).|
+|''%%--%%enemyai-algo ALGO''|Which EnemyAI algorithm to use. Possible options are ''RPG_RT'' (The default RPG_RT compatible algo, including RPG_RT bugs) and ''RPG_RT+'' (The default RPG_RT compatible algo, with bug fixes).|
+|''%%--%%patch 'PATCH_A' ['PATCH_B' '…']''|Force emulation of engine patches, disabling auto detection. Possible options are ''none'' (Disable all patches), ''dynrpg'' (DynRPG patch by Cherry) and ''maniac'' (Maniac Patch by BingShan).|
+|''%%--%%start-map-id N''|Overwrite the map used for new games and use MapN.lmu instead (''N'' is padded to four digits). Incompatible with ''load-game-id''.|
+|''%%--%%start-position X Y''|Overwrite the party start position and move the party to position (''X'', ''Y''). Incompatible with ''load-game-id''.|
+|''%%--%%start-party A B...''|Overwrite the starting party members with the actors with IDs ''A'', ''B'', ''C''... Incompatible with ''load-game-id''.|
+|''%%--%%language LANG''|Loads the game translation in language/'LANG' folder.|
+|''%%--%%soundfont FILE''|Adds ''FILE'' to the list of soundfonts used for playing MIDI files and use this one with highest precedence. The soundfont must be in SF2 format.|
+|''%%--%%test-play'' or ''TestPlay''|Enable test play mode.|
+|''%%--%%window'' or ''Window''|Start in window mode.|
+|''%%--%%no-log-color''|Disable colors in terminal log.|
+|''%%-%%v'' or ''%%--%%version''|Display program version and exit.|
+|''%%-%%h'' or ''%%--%%help''|Display help and exit.|
+===== Providing command parameters on player-web =====
+In player web, command line parameters can be passed by providing them as part of the query string as **URL parameters** . For example, if you want to provide **--show-fps** and **--game-resolution widescreen** at Test Game, you can provide as follows: https://easyrpg.org/play/**?show-fps&game-resolution=widescreen**