Skip to content

Commit

Permalink
Document --config-path and fix typos/indent
Browse files Browse the repository at this point in the history
  • Loading branch information
Ghabry committed Mar 16, 2023
1 parent d922c9b commit 064decc
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ insert_final_newline = true
indent_style = space
indent_size = 4

[*.{sh,rb,js,yml}]
[*.{sh,rb,js,yml,adoc}]
indent_style = space
indent_size = 2

Expand Down
49 changes: 27 additions & 22 deletions resources/unix/easyrpg-player.6.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,14 @@ for some additional binary patches.
- 'RPG_RT+' - The default RPG_RT compatible algo, with bug fixes
- 'ATTACK' - Like RPG_RT+, but only physical attacks, no skills

*-c*, *--config-path* 'PATH'::
Set a custom configuration path. When not specified, the configuration folder
in the users home directory is used. The default configuration path is
'$XDG_CONFIG_HOME/EasyRPG/Player'.

*--encoding* 'ENCODING'::
Instead of autodetecting the encoding or using the one in 'RPG_RT.ini', the
specified encoding is used.
specified encoding is used.

*--enemyai-algo* 'ALGO'::
Which EnemyAI algorithm to use. Possible options:
Expand Down Expand Up @@ -63,11 +68,11 @@ for some additional binary patches.

*--patch* 'PATCH_A' ['PATCH_B' '...']::
Instead of autodetecting patches used by this game, force emulation of certain
patches,
- 'common-this' - Support for __This Event__ in common events
patches.
- 'common-this' - Support for __This Event__ in common events
- 'dynrpg' - DynRPG patch by Cherry
- 'maniac' - Maniac Patch by BingShan
- 'unlock-pics' - Pictures are not blocked by messages
- 'unlock-pics' - Pictures are not blocked by messages

*--no-patch*::
Disable all engine patches.
Expand All @@ -80,9 +85,9 @@ for some additional binary patches.

*--replay-input* 'FILE'::
Replays button input from 'FILE', as generated by **--record-input**. If the
RNG seed (**--seed**) and the state of the save file directory are the same as
it was when the log was recorded, this should reproduce an identical run to
the one recorded.
RNG seed (**--seed**) and the state of the save file directory are the same as
it was when the log was recorded, this should reproduce an identical run to
the one recorded.

*--rtp-path* 'PATH'::
Adds 'PATH' to the RTP directory list and use this one with highest
Expand All @@ -103,8 +108,8 @@ directory!

*--fps-limit*::
In combination with *--no-vsync* sets a custom frames per second limit. If
unspecified, the default is 60 fps. Set to 0 or use **--no-fps-limit** to
disable the frame limiter. This option may not be supported on all platforms.
unspecified, the default is 60 fps. Set to 0 or use **--no-fps-limit** to
disable the frame limiter. This option may not be supported on all platforms.

*--fps-render-window*::
Render the frames per second counter in both fullscreen and windowed mode.
Expand All @@ -115,32 +120,32 @@ directory!

*--game-resolution* 'RESOLUTION'::
Force a different game resolution. RPG Maker games are designed for 320x240.
This option fakes certain metrics to make games run at higher resolutions.
Rendering in a different resolution can cause graphical glitches or break
games entirely. Possible options:
This option fakes certain metrics to make games run at higher resolutions.
Rendering in a different resolution can cause graphical glitches or break
games entirely. Possible options:
- 'original' - 320x240 (4:3), the default resolution
- 'widescreen' - 416x240 (16:9)
- 'ultrawide' - 560x240 (21:9)

*--scaling* 'MODE'::
How the video output is scaled. Possible options:
- 'nearest' - Scale to screen size using nearest neighbour algorithm.
This is fast, but causes scaling artifacts.
This is fast, but causes scaling artifacts.
- 'integer' - Like 'nearest' but scales to a multiple of the game
resolution to avoid artifacts.
resolution to avoid artifacts.
- 'bilinear' - Like 'nearest' but apply a bilinear filter to avoid the
artifacts.
artifacts.
*--show-fps*::
Enable display of the frames per second counter. Can be disabled with
*--no-show-fps*.
*--no-show-fps*.

*--stretch*::
Ignore the aspect ratio and stretches video output to the entire width of the
screen. Can be disabled with *--no-stretch*.
Ignore the aspect ratio and stretch video output to the entire width of the
screen. Can be disabled with *--no-stretch*.

*--vsync*::
Enables vertical sync. Vsync may or may not be supported on all platforms.
Check the engine log to verify whether or not vsync actually is being used.
Check the engine log to verify whether or not vsync actually is being used.
Can be disabled with *--no-vsync*.

*--window*::
Expand All @@ -167,11 +172,11 @@ directory!

*--battle-test* 'MONSTERPARTY'::
Starts a battle test with the specified monster party. This is for starting
battle tests in RPG Maker 2000.
battle tests in RPG Maker 2000.

*--battle-test* 'MONSTERPARTY' 'FORMATION' 'CONDITION' 'TERRAIN'::
Starts a battle test with the specified monster party, formation, start
condition and terrain. This is for starting battle tests in RPG Maker 2003.
condition and terrain. This is for starting battle tests in RPG Maker 2003.

*--hide-title*::
Hide the title background image and center the command menu.
Expand Down Expand Up @@ -249,7 +254,7 @@ to specify a soundfont on the command line.

'EasyRPG.ini'::
Sets game specific settings to alter the engine behaviour. It follows a
simple *Key*='Value' syntax in multiple sections.
simple *Key*='Value' syntax in multiple sections.
----
[Game]
NewGame=1 <- Equals --new-game
Expand Down
16 changes: 9 additions & 7 deletions src/player.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@ void Player::CreateGameObjects() {
}
}

Output::Debug("Patch configuration: dynrpg={} maniac={} this-event={} pic-unlock={}",
Output::Debug("Patch configuration: dynrpg={} maniac={} common-this={} pic-unlock={}",
Player::IsPatchDynRpg(), Player::IsPatchManiac(), game_config.patch_common_this_event.Get(), game_config.patch_unlock_pics.Get());

ResetGameObjects();
Expand Down Expand Up @@ -1351,6 +1351,8 @@ Engine options:
fixes.
ATTACK - Like RPG_RT+ but only physical attacks, no
skills.
-c, --config-path P Set a custom configuration path. When not specified, the
configuration folder in the users home directory is used.
--encoding N Instead of autodetecting the encoding or using the one in
RPG_RT.ini, the encoding N is used.
--enemyai-algo A Which EnemyAI algorithm to use.
Expand All @@ -1374,12 +1376,12 @@ Engine options:
--no-log-color Disable colors in terminal log.
--no-rtp Disable support for the Runtime Package (RTP).
--patch PATCH... Instead of autodetecting patches used by this game, force
emulation of certain patches,
emulation of certain patches.
Options:
common-this - "This Event" in common events
dynrpg - DynRPG patch by Cherry
maniac - Maniac Patch by BingShan
pic-unlock - Pictures are not blocked by messages
common-this - "This Event" in common events
dynrpg - DynRPG patch by Cherry
maniac - Maniac Patch by BingShan
pic-unlock - Pictures are not blocked by messages
--no-patch Disable all engine patches.
--project-path PATH Instead of using the working directory, the game in PATH
is used.
Expand Down Expand Up @@ -1416,7 +1418,7 @@ Video options:
avoid artifacts.
--show-fps Enable display of the frames per second counter.
Disable with --no-show-fps.
--stretch Ignore the aspect ratio and stretches video output to the
--stretch Ignore the aspect ratio and stretch video output to the
entire width of the screen.
Disable with --no-stretch.
--vsync Enables vertical sync if supported on this platform.
Expand Down

0 comments on commit 064decc

Please sign in to comment.