easyrpg-player(6)

1EASYRPG-PLAYER(6)               EasyRPG Manual               EASYRPG-PLAYER(6)
2
3
4

NAME

6       easyrpg-player - Interpreter for RPG Maker 2000/2003 games
7

SYNOPSIS

9       easyrpg-player [<optional flags>...]
10

DESCRIPTION

12       EasyRPG Player is an open source interpreter for RPG Maker 2000 and
13       2003 games. It aims to support all features of unmodified games and
14       also has some support for some additional binary patches.
15

OPTIONS

17       --battle-test MONSTERPARTY
18           Starts a battle test with the specified monster party.
19
20       --disable-audio
21           Disable audio (in case you prefer your own music).
22
23       --disable-rtp
24           Disable support for the Runtime Package (RTP). Will lead to
25           checkerboard graphics and silent music/sound effects in games
26           depending on the RTP.
27
28       --encoding ENCODING
29           Instead of auto detecting the encoding or using the one in
30           RPG_RT.ini, the specified encoding is used. Use "auto" for
31           automatic detection.
32
33       --engine ENGINE
34           Disable auto detection of the simulated engine. Possible options:
35
36           •   rpg2k - RPG Maker 2000 engine (v1.00 - v1.10)
37
38           •   rpg2kv150 - RPG Maker 2000 engine (v1.50 - v1.51)
39
40           •   rpg2ke - RPG Maker 2000 (English release) engine (v1.61)
41
42           •   rpg2k3 - RPG Maker 2003 engine (v1.00 - v1.04)
43
44           •   rpg2k3v105 - RPG Maker 2003 engine (v1.05 - v1.09a)
45
46           •   rpg2k3e - RPG Maker 2003 (English release) engine
47
48       --fullscreen
49           Start in fullscreen mode.
50
51       --show-fps
52           Enable frames per second counter.
53
54       --fps-render-window
55           Render the frames per second counter in both full screen and
56           windowed mode.
57
58       --fps-limit
59           Set a custom frames per second limit. If unspecified, the default
60           is 60 fps. Set to 0 to disable the frame limiter. This option may
61           not be supported on all platforms.
62
63       --no-vsync
64           Disable vsync and use fps-limit. Vsync may or may not be supported
65           on all platforms. Check the engine log to verify whether or not
66           vsync actually is being used.
67
68       --enable-mouse
69           Use mouse click for decision and scroll wheel for lists.
70
71       --enable-touch
72           Use one/two finger tap for decision/cancel.
73
74       --hide-title
75           Hide the title background image and center the command menu.
76
77       --load-game-id ID
78           Skip the title scene and load SaveID.lsd (ID is padded to two
79           digits).
80
81       --new-game
82           Skip the title scene and start a new game directly.
83
84       --project-path PATH
85           Instead of using the working directory the game in PATH is used.
86
87       --rtp-path PATH
88           Adds PATH to the RTP directory list and use this one with highest
89           precedence.
90
91       --record-input PATH
92           Records all button input to a log file at PATH.
93
94       --replay-input PATH
95           Replays button input from a log file at PATH, as generated by
96           --record-input. If the RNG seed (--seed) and the state of the save
97           file directory is also the same as it was when the log was
98           recorded, this should reproduce an identical run to the one
99           recorded.
100
101       --save-path PATH
102           Instead of storing save files in the game directory they are stored
103           in PATH. The directory must exist.
104
105           Note
106           When using the game browser all games will share the same save
107           directory!
108
109       --seed SEED
110           Seeds the random number generator.
111
112       --autobattle-algo ALGO
113           Which AutoBattle algorithm to use. Possible options:
114
115           •   RPG_RT - The default RPG_RT compatible algo, including RPG_RT
116               bugs
117
118           •   RPG_RT+ - The default RPG_RT compatible algo, with bug fixes
119
120           •   ATTACK - RPG_RT+ but only physical attacks, no skills
121
122       --enemyai-algo ALGO
123           Which EnemyAI algorithm to use. Possible options:
124
125           •   RPG_RT - The default RPG_RT compatible algo, including RPG_RT
126               bugs
127
128           •   RPG_RT+ - The default RPG_RT compatible algo, with bug fixes
129
130       --patch PATCH_A [PATCH_B ...]
131           Force emulation of engine patches, disabling auto detection.
132           Possible options:
133
134           •   none - Disable all patches
135
136           •   dynrpg - DynRPG patch by Cherry
137
138           •   maniac - Maniac Patch by BingShan
139
140       --start-map-id ID
141           Overwrite the map used for new games and use MapID.lmu instead (ID
142           is padded to four digits).
143
144           Note
145           Incompatible with --load-game-id.
146
147       --start-position X Y
148           Overwrite the party start position and move the party to position
149           (X, Y).
150
151           Note
152           Incompatible with --load-game-id.
153
154       --start-party A [B ...]
155           Overwrite the starting party members with the actors with IDs A, B,
156           ...
157
158           Note
159           Incompatible with --load-game-id.
160
161       --test-play
162           Enable TestPlay mode.
163
164       --window
165           Start in window mode.
166
167       --no-log-color
168           Disable colors in terminal log.
169
170       -v, --version
171           Display program version and exit.
172
173       -h, --help
174           Display help and exit.
175
176       For compatibility with the original RPG Maker runtime the following
177       legacy arguments are supported:
178
179       BattleTest ID
180           Same as --battle-test. When ID is not a valid number the 4th
181           argument is used as the party id.
182
183       HideTitle
184           Same as --hide-title.
185
186       TestPlay
187           Same as --test-play.
188
189       Window
190           Same as --window.
191

ENVIRONMENT

193       RPG2K_RTP_PATH
194           Full path to a directory containing an extracted RPG Maker 2000
195           Run-Time-Package(RTP).
196
197       RPG2K3_RTP_PATH
198           Full path to a directory containing an extracted RPG Maker 2003
199           RTP.
200
201       RPG_RTP_PATH
202           Full path to a directory containing a combined RTP.
203
204           Note
205           All *_RTP_PATH variables support directory lists, using colon (:)
206           or semicolon (;) as separator. Useful when you have multiple
207           translated RTP versions or directories with extra files. The
208           --rtp-path command line option supports directory lists as well.
209

FILES

211       RPG_RT.ini
212           The game configuration file. It follows a simple Key=Value syntax
213           in multiple sections. Specific options can be set in the [EasyRPG]
214           section. For example:
215
216           [EasyRPG]
217           Encoding=1252
218
219           This will set the correct encoding for most english games.
220
221           Note
222           Values in the configuration file will overwrite auto detected ones,
223           however command line parameters will take precedence.
224

REPORTING BUGS

226       Bugs should be reported at the issue tracker:
227       https://github.com/EasyRPG/Player/issues
228

COPYRIGHT / AUTHORS

230       EasyRPG Player is Copyright © 2007-2021 the EasyRPG authors, see file
231       AUTHORS.md for details.
232
233       This program is free software; you can redistribute it and/or modify it
234       under the terms of the GNU GPL version 3. See the file COPYING or
235       http://gnu.org/licenses/gpl.html for details.
236