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       --record-input PATH
88           Records all button input to a log file at PATH.
89
90       --replay-input PATH
91           Replays button input from a log file at PATH, as generated by
92           --record-input. If the RNG seed (--seed) and the state of the save
93           file directory is also the same as it was when the log was
94           recorded, this should reproduce an identical run to the one
95           recorded.
96
97       --save-path PATH
98           Instead of storing save files in the game directory they are stored
99           in PATH. The directory must exist.
100
101           Note
102           When using the game browser all games will share the same save
103           directory!
104
105       --seed SEED
106           Seeds the random number generator.
107
108       --start-map-id ID
109           Overwrite the map used for new games and use MapID.lmu instead (ID
110           is padded to four digits).
111
112           Note
113           Incompatible with --load-game-id.
114
115       --start-position X Y
116           Overwrite the party start position and move the party to position
117           (X, Y).
118
119           Note
120           Incompatible with --load-game-id.
121
122       --start-party A [B ...]
123           Overwrite the starting party members with the actors with IDs A, B,
124           ...
125
126           Note
127           Incompatible with --load-game-id.
128
129       --test-play
130           Enable TestPlay mode.
131
132       --window
133           Start in window mode.
134
135       -v, --version
136           Display program version and exit.
137
138       -h, --help
139           Display help and exit.
140
141       For compatibility with the original RPG Maker runtime the following
142       legacy arguments are supported:
143
144       BattleTest ID
145           Same as --battle-test. When ID is not a valid number the 4th
146           argument is used as the party id.
147
148       HideTitle
149           Same as --hide-title.
150
151       TestPlay
152           Same as --test-play.
153
154       Window
155           Same as --window.
156

ENVIRONMENT

158       RPG2K_RTP_PATH
159           Full path to a directory containing an extracted RPG Maker 2000
160           Run-Time-Package(RTP).
161
162       RPG2K3_RTP_PATH
163           Full path to a directory containing an extracted RPG Maker 2003
164           RTP.
165
166       RPG_RTP_PATH
167           Full path to a directory containing a combined RTP.
168
169           Note
170           All *_RTP_PATH variables support directory lists, using colon (:)
171           or semicolon (;) as separator. Useful when you have multiple
172           translated RTP versions or directories with extra files.
173

FILES

175       RPG_RT.ini
176           The game configuration file. It follows a simple Key=Value syntax
177           in multiple sections. Specific options can be set in the [EasyRPG]
178           section. For example:
179
180           [EasyRPG]
181           Encoding=1252
182
183           This will set the correct encoding for most english games.
184
185           Note
186           Values in the configuration file will overwrite auto detected ones,
187           however command line parameters will take precedence.
188

REPORTING BUGS

190       Bugs should be reported at the issue tracker:
191       https://github.com/EasyRPG/Player/issues
192

COPYRIGHT / AUTHORS

194       EasyRPG Player is Copyright © 2007-2017 the EasyRPG authors, see file
195       AUTHORS.md for details.
196
197       This program is free software; you can redistribute it and/or modify it
198       under the terms of the GNU GPL version 3. See the file COPYING or
199       http://gnu.org/licenses/gpl.html for details.
200