easyrpg-player(6)

1EASYRPG-PLAYER(6)                    0.8""                   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   Engine options
18       --autobattle-algo ALGO
19           Which AutoBattle algorithm to use. Possible options:
20
21           •   'RPG_RT'     - The default RPG_RT compatible algo, including
22               RPG_RT bugs
23
24           •   'RPG_RT+'    - The default RPG_RT compatible algo, with bug
25               fixes
26
27           •   'ATTACK'     - Like RPG_RT+, but only physical attacks, no
28               skills
29
30       -c, --config-path PATH
31           Set a custom configuration path. When not specified, the
32           configuration folder in the users home directory is used. The
33           default configuration path is '$XDG_CONFIG_HOME/EasyRPG/Player'.
34
35       --encoding ENCODING
36           Instead of autodetecting the encoding or using the one in
37           'RPG_RT.ini', the specified encoding is used. 'ENCODING' is the
38           number of the codepage used in Windows. Common encodings:
39
40           •   '932'  - Japanese (Shift-JIS)
41
42           •   '936'  - Simplified Chinese (GB2312)
43
44           •   '949'  - Korean (Unified Hangul)
45
46           •   '950'  - Traditional Chinese (Big5)
47
48           •   '1250' - Central European
49
50           •   '1251' - Cyrillic
51
52           •   '1252' - Western European (Latin 1)
53
54           Note
55           For games that only use ASCII (English games) use '1252'.
56
57       --enemyai-algo ALGO
58           Which EnemyAI algorithm to use. Possible options:
59
60           •   'RPG_RT'      - The default RPG_RT compatible algo, including
61               RPG_RT bugs
62
63           •   'RPG_RT+'     - The default RPG_RT compatible algo, with bug
64               fixes
65
66       --engine ENGINE
67           Disable autodetection of the simulated engine. Possible options:
68
69           •   'rpg2k'       - RPG Maker 2000 (v1.00 - v1.10)
70
71           •   'rpg2kv150'   - RPG Maker 2000 (v1.50 - v1.51)
72
73           •   'rpg2ke'      - RPG Maker 2000 RPG Maker 2000 (English release,
74               v1.61)
75
76           •   'rpg2k3'      - RPG Maker 2003 (v1.00 - v1.04)
77
78           •   'rpg2k3v105'  - RPG Maker 2003 (v1.05 - v1.09a)
79
80           •   'rpg2k3e'     - RPG Maker 2003 RPG Maker 2003 (English release,
81               v1.12)
82
83       --language LANG
84           Loads the game translation in language/'LANG' folder.
85
86       --load-game-id ID
87           Skip the title scene and load SaveID.lsd ('ID' is padded to two
88           digits).
89
90       --new-game
91           Skip the title scene and start a new game directly.
92
93       --no-log-color
94           Disable colors in terminal log.
95
96       --no-rtp
97           Disable support for the Runtime Package (RTP). Will lead to
98           checkerboard graphics and silent music/sound effects in games
99           depending on the RTP.
100
101       --patch PATCH_A [PATCH_B ...]
102           Instead of autodetecting patches used by this game, force emulation
103           of certain patches.
104
105           •   'common-this' - Support for This Event in common events
106
107           •   'dynrpg'      - DynRPG patch by Cherry
108
109           •   'key-patch'   - Key Patch by Ineluki
110
111           •   'maniac'      - Maniac Patch by BingShan
112
113           •   'pic-unlock'  - Pictures are not blocked by messages
114
115           •   'rpg2k3-cmds' - Support RPG Maker 2003 event commands in all
116               engines
117
118       --no-patch
119           Disable all engine patches.
120
121       --project-path PATH
122           Instead of using the working directory, the game in 'PATH' is used.
123
124       --record-input FILE
125           Record all button inputs to 'FILE'.
126
127       --replay-input FILE
128           Replays button input from 'FILE', as generated by --record-input.
129           If the RNG seed (--seed) and the state of the save file directory
130           are the same as it was when the log was recorded, this should
131           reproduce an identical run to the one recorded.
132
133       --rtp-path PATH
134           Adds 'PATH' to the RTP directory list and use this one with highest
135           precedence.
136
137       --save-path PATH
138           Instead of storing save files in the game directory they are stored
139           in 'PATH'. The directory must exist.
140
141           Note
142           When using the game browser all games will share the same save
143           directory!
144
145       --seed SEED
146           Seeds the random number generator.
147
148   Video options
149       --fps-limit
150           In combination with --no-vsync sets a custom frames per second
151           limit. If unspecified, the default is 60 fps. Set to 0 or use
152           --no-fps-limit to disable the frame limiter. This option may not be
153           supported on all platforms.
154
155       --fps-render-window
156           Render the frames per second counter in both fullscreen and
157           windowed mode. Can be disabled with --no-fps-render-window.
158
159       --fullscreen
160           Start in fullscreen mode.
161
162       --game-resolution RESOLUTION
163           Force a different game resolution. RPG Maker games are designed for
164           320x240. This option fakes certain metrics to make games run at
165           higher resolutions. Rendering in a different resolution can cause
166           graphical glitches or break games entirely. Possible options:
167
168           •   'original'    - 320x240 (4:3), the default resolution
169
170           •   'widescreen'  - 416x240 (16:9)
171
172           •   'ultrawide'   - 560x240 (21:9)
173
174       --scaling MODE
175           How the video output is scaled. Possible options:
176
177           •   'nearest'    - Scale to screen size using nearest neighbour
178               algorithm. This is fast, but causes scaling artifacts.
179
180           •   'integer'    - Like 'nearest' but scales to a multiple of the
181               game resolution to avoid artifacts.
182
183           •   'bilinear'   - Like 'nearest' but apply a bilinear filter to
184               avoid the artifacts.
185
186       --show-fps
187           Enable display of the frames per second counter. Can be disabled
188           with --no-show-fps.
189
190       --stretch
191           Ignore the aspect ratio and stretch video output to the entire
192           width of the screen. Can be disabled with --no-stretch.
193
194       --vsync
195           Enables vertical sync. Vsync may or may not be supported on all
196           platforms. Check the engine log to verify whether or not vsync
197           actually is being used. Can be disabled with --no-vsync.
198
199       --window
200           Start in windowed mode.
201
202   Audio options
203       --disable-audio
204           Disable audio (in case you prefer your own music).
205
206       --music-volume VOLUME
207           Set the volume of background music to a value from 0 to 100.
208
209       --sound-volume VOLUME
210           Set the volume of sound effects to a value from 0 to 100.
211
212       --soundfont FILE
213           Adds 'FILE' to the list of soundfonts used for playing MIDI files
214           and use this one with highest precedence. The soundfont must be in
215           SF2 format.
216
217   Debug options
218       --battle-test MONSTERPARTY
219           Starts a battle test with the specified monster party. This is for
220           starting battle tests in RPG Maker 2000.
221
222       --battle-test MONSTERPARTY FORMATION CONDITION TERRAIN
223           Starts a battle test with the specified monster party, formation,
224           start condition and terrain. This is for starting battle tests in
225           RPG Maker 2003.
226
227       --hide-title
228           Hide the title background image and center the command menu.
229
230       --start-map-id ID
231           Overwrite the map used for new games and use MapID.lmu instead
232           ('ID' is padded to four digits).
233
234           Note
235           Incompatible with --load-game-id.
236
237       --start-position X' 'Y
238           Overwrite the party start position and move the party to position
239           ('X', 'Y').
240
241           Note
242           Incompatible with --load-game-id.
243
244       --start-party A [B ...]
245           Overwrite the starting party members with the actors with IDs 'A',
246           'B', '...'
247
248           Note
249           Incompatible with --load-game-id.
250
251       --test-play
252           Enable TestPlay (Debug) mode.
253
254   Other options
255       -v, --version
256           Display program version and exit.
257
258       -h, --help
259           Display help and exit.
260
261       For compatibility with the original RPG Maker runtime the following
262       legacy arguments are supported:
263
264       BattleTest ID
265           Same as --battle-test. The argument list starts at the 4th
266           argument.
267
268       HideTitle
269           Same as --hide-title.
270
271       TestPlay
272           Same as --test-play.
273
274       Window
275           Same as --window.
276

ENVIRONMENT

278       'RPG2K_RTP_PATH'
279           Full path to a directory containing an extracted RPG Maker 2000
280           Runtime Package (RTP).
281
282       'RPG2K3_RTP_PATH'
283           Full path to a directory containing an extracted RPG Maker 2003
284           RTP.
285
286       'RPG_RTP_PATH'
287           Full path to a directory containing a combined RTP.
288
289           Note
290           All '*_RTP_PATH' variables support directory lists, using colon
291           (':') or semicolon (';') as separator. Useful when you have
292           multiple translated RTP versions or directories with extra files.
293           The '--rtp-path' command line option supports directory lists as
294           well.
295
296       'SDL_SOUNDFONTS'
297           List of soundfonts in sf2 format to use when playing MIDI files.
298           The first existing soundfont is used.
299
300           Note
301           Use colon (':') or semicolon (';') as separator. Use '--soundfont'
302           to specify a soundfont on the command line.
303

FILES

305   EasyRPG.ini
306       Sets game specific settings to alter the engine behaviour. It follows a
307       simple Key=Value syntax in multiple sections.
308
309       Options in section 'Game':
310
311       NewGame=1
312           Same as --new-game.
313
314       FakeResolution=1
315           When 'WinW'/'WinH' in 'RPG_RT.ini' are used, enable the metric
316           faking algorithm used by --game-resolution.
317
318       Engine=ENGINE
319           Same as --engine.
320
321       Options in section 'Patch' (see also --patch):
322
323       CommonThisEvent=1
324           Same as --patch common-this.
325
326       DynRPG=1
327           Same as --patch dynrpg.
328
329       KeyPatch=1
330           Same as --patch key-patch.
331
332       Maniac=1
333           Same as --patch maniac.
334
335       PicUnlock=1
336           Same as --patch pic-unlock.
337
338       RPG2k3Commands=1
339           Same as --patch rpg2k3-commands.
340
341           Note
342           Providing any patch option disables the patch autodetection of the
343           engine.
344
345       Example:
346
347           [Game]
348           NewGame=1
349           Engine=rpg2k
350
351           [Patch]
352           CommonThisEvent=1
353           Maniac=1
354
355           Note
356           Values in the configuration file will overwrite auto detected ones,
357           however command line parameters will take precedence.
358
359   RPG_RT.ini
360       The game configuration file. It follows a simple Key=Value syntax in
361       multiple sections.
362
363       Options in section 'RPG_RT':
364
365       GameTitle=TITLE
366           Title shown in the titlebar. The string must have the same encoding
367           as the game (see also --encoding).
368
369       FullPackageFlag=1
370           Indicates that the game does not use assets from the Runtime
371           Package (RTP).
372
373       WinW=WIDTH
374           Set a custom screen width in pixel. Use this in combination with
375           WinH. The x and y coordinate are at the top-left corner. This
376           behaviour can be altered with FakeResolution.
377
378       WinH=HEIGHT
379           Set a custom screen height.
380
381           Note
382           These resolution options invented by the Maniac Patch but they are
383           processed even when the patch is disabled. Using a custom
384           resolution disables --game-resolution.
385
386       Options in section 'EasyRPG':
387
388       Encoding=ENCODING
389           Same as --encoding.
390
391       Example:
392
393           [RPG_RT]
394           GameTitle=My Game
395           FullPackageFlag=1
396           WinW=640
397           WinH=480
398
399           [EasyRPG]
400           Encoding=1252
401
402       'Encoding=1252' sets the correct encoding for most english games.
403
404           Note
405           Values in the configuration file will overwrite auto detected ones,
406           however command line parameters will take precedence.
407

REPORTING BUGS

409       Bugs should be reported at the issue tracker:
410       https://github.com/EasyRPG/Player/issues
411

COPYRIGHT / AUTHORS

413       EasyRPG Player is Copyright © 2007-2023 the EasyRPG authors, see file
414       AUTHORS.md for details.
415
416       This program is free software; you can redistribute it and/or modify it
417       under the terms of the GNU GPL version 3. See the file COPYING or
418       http://gnu.org/licenses/gpl.html for details.
419