Differences

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

--- user:player:settings-menu [2023/11/25 13:59] – created carbonara
+++ user:player:settings-menu [2026/07/06 19:04] (current) – [Engine] carbonara
@@ Line 4: / Line 4: @@
 This menu can be either opened from the game browser menu by selecting the Settings entry, by pressing the settings key (F1 or Start by default) while in-game, or if a game uses the command //Open Video Options//, this menu will also be called.
 The menu is separated in several categories, with //Video//, //Audio//, //Input// and //Engine//, as well as the entries //Save Settings// and //Exit Game//.
+While playing a game that uses the [[https://easyrpg.org/player/guide/game_translation/|language feature from EasyRPG]], a //Language// button will be added in the settings menu between //Input// and //Engine//, and will allow changing the language of the game.
 The configuration of the settings is saved on the user side in:
-Windows: ''/Users/(Username)/AppData/Roaming/EasyRPG/Player/config.ini''
+Windows: ''/%USERPROFILE%/AppData/Roaming/EasyRPG/Player/config.ini''
 Android: ''/storage/emulated/0/Android/data/org.easyrpg.player/files/config.ini''
@@ Line 13: / Line 14: @@
 Wii & 3DS: ''/data/easyrpg-player/config.ini''
-RetroArch: ''(RetroArch location)/system/easyrpg-player/config.ini''
+RetroArch: ''/<libretro-path-set-for-system-and-bios-files>/easyrpg-player/config.ini''
+ FIXME Add paths for Mac OS, Linux, Wii U, Nintendo Switch, PlayStation Vita
@@ Line 25: / Line 28: @@
 | V-Sync | ON | Enable vertical sync to prevent screen tearing. Having this setting enabled will prevent you from editing the frame limiter. |
 | Frame Limiter | 60 | Only available if //V-Sync// is OFF. Allows you to set a custom value for the limit of frames per second. Setting it to 0 will consider the limit as being illimited. |
-| Show FPS | OFF | Display an FPS counter, either on-screen if the game is in fullscreen or in the name of the window if the game is in windowed mode. This action can also be performed by using the //Toggle Fps// key (by default F2 or the button RT of a controller). |
+| Show FPS | OFF | Display an FPS counter, either on-screen if the game is in fullscreen, with it in the name of the window if the game is in windowed mode if ON is selected, or always on-screen and not in the window name if Overlay is selected. This action can also be performed by using the //Toggle Fps// key (by default F2 or the button RT of a controller). |
-| Show FPS in Window | OFF | If the setting //Show FPS// is enabled and that the game is in windowed mode, the FPS counter will also be displayed on-screen in addition to being displayed in the name of the window. |
 | Stretch | OFF | Stretch horizontally the width of the window or screen of the game. |
-| Scaling Method | Bilinear | Change how the output of the game is scaled. //Integer// will scale it to a multiple of the game resolution (causing black bars to display above and below if your screen is not a multiple of the game resolution), //Nearest// is directly scaled to the screen size, causing scaling artifacts, while //Bilinear// is scaled with nearest neighbour to a suitable resolution slightly higher than your screen resolution and afterwards a bilinear downscale is done, allowing to not cause artifacts, though it will make it lose a bit of sharpness compared to //Integer//. |
+| Scaling Method | Bilinear | Change how the output of the game is scaled. //Integer// will scale it to a multiple of the game resolution (causing black bars to display above and below if your screen is not a multiple of the game resolution), //Nearest// is directly scaled to the screen size, causing scaling artifacts, while //Bilinear// is scaled with nearest neighbour to a suitable resolution slightly higher than your screen resolution and afterwards a bilinear downscale is done, allowing to not cause artifacts, though it will make it lose a bit of sharpness compared to //Integer//. As Bilinear needs to render the window of the game twice, requesting more power, you may want to switch this setting to Integer or Bilinear for lower-end platforms. |
+| Pause when focus lost | ON | Make the game pause if the window of the game is no longer in focus. |
 | Resolution | Original | Change the game resolution. This setting is updated and applied once on the title screen of a game; changing it in the middle of a game will not update it until returning to the title screen (or restarting by holding the restart key for games skipping the title screen). The 3 options available are //Original// (320x240, 4:3, recommended), //Widescreen// (416x240, 16:9, experimental) and //Ultrawide// (560x240, 21:9, experimental). Since the games aren't made with the widescreen and ultrawide settings in mind, you may encounter graphical issues in them, though the games should still be 100% playable compared to how they are usually played with the original resolution. This setting cannot be edited if the game uses a custom resolution. |
 | Backlight | ON | Toggle the backlight of the bottom screen. Only available on Nintendo 3DS. |
@@ Line 34: / Line 37: @@
 ===== Audio =====
-Allows you to change the audio settings of the Player. These options are not available if the flag ''--disable-audio'' is set.
+Allows you to change the audio settings of the Player. The Audio menu is not available if the flag ''--disable-audio'' is set.
 ^ Entry ^ Default ^ Function ^
 | BGM Volume | 100 | Adjust the volume of the background music, where 100 is the maximum volume and 0 is no music. |
 | SFX Volume | 100 | Adjust the volume of the sound effects, where 100 is the maximum volume and 0 is no sound effects. |
+| MIDI Drivers |   | Open the MIDI Drivers selection screen. See the MIDI Drivers section for more details. |
+| Soundfont | <Autodetect> | Allows to select a soundfont file. See the Soundfont section for more details. The Soundfont option is not available directly in the settings on Android, as it requires it to be set through the Android settings menu. |
+The following settings are available for the MIDI Drivers section. The highest MIDI driver in the list set to ON that is valid for MIDI files will be the one used.
+^ Entry ^ Default ^ Function ^
+| FluidSynth (SF2) | ON | MIDI driver that requires soundfont files (.sf2). The soundfont selected will be the one set in the Soundfont section, so refer to the Soundfont section for more details. By default, since no soundfont is set and that almost no game uses a custom soundfont, it will not end up being used. |
+| FluidLite (SF2) | ON | MIDI driver that requires soundfont files (.sf2). It is an alternative to FluidSynth, and is instead used on platforms with less power, such as homebrew platforms. The soundfont selected will be the one set in the Soundfont section, so refer to the Soundfont section for more details. By default, since no soundfont is set and that almost no game uses a custom soundfont, it will not end up being used. |
+| WildMidi | ON | MIDI driver that requires to use a configuration file (wildmidi.cfg), and will rely on instruments set within the configuration file. By default, since no configuration is set and that almost no game comes with a WildMidi configuration, it will not end up being used. Refer to the [[platforms|Platform Differences]] page to know where the wildmidi.cfg file should be placed depending on the platform. |
+| Native MIDI | ON | Uses the native MIDI driver of the platform, which should sound identical to what the original engine does. Only available on Windows, and will be the default MIDI setting that most platforms will hear on this platform. |
+| FmMidi | Always ON | MIDI Driver that plays MIDI sounds in a similar way than a Yamaha YM2608 FM synthesizer, and has an electronic sound. As it is present on every platform, and does not require any dependency to be used, it will be the default setting heard by most players. It cannot be set to OFF. |
+| > Information < |   | Displays basic information on midi files. |
+The Soundfont section contains the following options:
+^ Entry ^ Default ^ Function ^
+| <Autodetect> | [x] | If the selected game contains an easyrpg.soundfont file at its root, this soundfont will be used. |
+| CustomSoundfont.sf2 |   | Soundfont files with the .sf2 extension added to the Soundfont directory by the user. Once selected, the soundfont will start to be played on the next MIDI file played. |
+| <Open Soundfont directory> |   | Open the Soundfont directory on desktop platforms. Soundfont files with the .sf2 extension must be placed there. For platforms not supporting this, refer to the [[platforms|Platform Differences]] page to know where the Soundfont folder is located.  |
+| <Upload Soundfont> |   | Upload a soundfont file to the Player. This feature is only available on the webplayer, and the soundfont is only stored locally in the user storage, it is not sent to any server.  |
 ===== Input =====
 Allows you to edit the mapping of the keys as well as some options related to them. Note that the keys used, and as such the mapping set by default, depend on the platform.
 ^ Entry ^ Default ^ Function ^
-| Key/Button mapping |  Consult the [[user:player:buttons|Button Mapping]] page to see the default mapping on PC. | Allows you to edit the mapping of the keys used by the Player. The keys are separated in 3 different categories, **Game** for the keys used in the games, **Engine** for the keys related to the features of the engine and **Developer** for the keys related to the Test Play mode or debug features. By holding 4 different keys (no need to be mapped) while selecting an entry during 3 seconds, its mapping will be reset; more globally, if you hold 4 different keys anywhere else in the settings menu or if you hold them for 3 additional seconds, the mapping of all of the keys will also be reset. |
+| Key/Button mapping |  Consult the [[user:player:buttons|Button Mapping]] page to see the default mapping on PC. | Allows you to edit the mapping of the keys used by the Player. The keys are separated in 3 different categories, **Game** for the keys used in the games, **Engine** for the keys related to the features of the engine and **Developer** for the keys related to the Test Play mode or debug features. By holding 4 different keys (no need to be mapped) while selecting an entry during 3 seconds, its mapping will be reset; more globally, if you hold 4 different keys anywhere else in the settings menu or if you hold them for 3 additional seconds, the mapping of all of the keys will also be reset. Important keys (Up, Down, Left, Right, Decision, Cancel and Settings) cannot be entirely unmapped (they need to be mapped to at least one key unlike the other entries), and a maximum of 16 different keys can be mapped to a single entry. |
 | Gamepad: Swap AB and XY | OFF | Swap the A button with the B button and the X button with the Y button on a controller, to match with how the layout is reversed between a Nintendo and an Xbox controller. |
 | Gamepad: Swap Analog Sticks | OFF | Swap the left analog stick with the right analog stick. |
@@ Line 55: / Line 75: @@
 ^ Entry ^ Default ^ Function ^
+| Font 1 | <Built-in Font> | Allows to select a font file for the font 1 (used if a game sets its System file to use the font RPG2000). See the Font section for more details. The Font option is not available directly in the settings on Android, as it requires it to be set through the Android settings menu. If a game uses a custom font for its font 1, the font set will be ignored. |
+| Font 2 | <Built-in Font> | Allows to select a font file for the font 2 (used if a game sets its System file to use the font RPG2000G). See the Font section for more details. The Font option is not available directly in the settings on Android, as it requires it to be set through the Android settings menu. If a game uses a custom font for its font 2, the font set will be ignored. |
+| Startup Logos | Custom | Choose whether or not you want to see the logos that are usually displayed when starting a game with the original executable. None will display no logo, Custom will display the logo(s) that were made for the selected game and All will display the logo(s) that were included with the game, even if those present are from the original RPG Maker. |
 | Save settings on exit | OFF | If this setting is enabled, the settings configuration will be saved when exiting the Player. |
 | Show settings on title screen | OFF | Add a Settings menu item on the title screen, after the Load option, allowing you to open the Settings Menu. |
 | Show settings in menu | OFF | Add a Settings menu item on the menu screen, before the Exit option, allowing you to open the Settings Menu. |
-| Startup Logos | Custom | Choose whether or not you want to see the logos that are usually displayed when starting a game with the original executable. None will display no logo, Custom will display the logo(s) that were made for the selected game and All will display the logo(s) that were included with the game, even if those present are from the original RPG Maker. |
+| Startup Language Menu | First Start | When booting a game that uses the language feature, display the language screen before the title screen. Never disables this feature, on First Start only displays it as long as the user has no save file, and Always will always bring that menu when starting the game. |
+| Show language menu on title screen | ON | Add a Language menu item on the title screen if the game uses the language feature, after the Load option, allowing you to open the language selection menu. |
+| Logging | ON | Write logs in an EasyRPG-Player.log file when playing. To know where the log file is written on your platform, refer to the [[platforms|Platform Differences]] page. On some lower-end platforms like the 3DS, the logging feature is set to OFF by default as to require less power. |
+| Screenshot scaling factor | 1 | When taking a screenshot, scaling factor at which the screenshot is taken. By default, the scaling factor is set to the native resolution of the game, but can be set up to 24 if you need it to be. As outputting at higher resolution requires more resources, avoid doing that on lower-end platforms. |
+| Screenshot timestamp | ON | If the screenshot timestamp is set to ON, when taking a screenshot, it will be stored with the filename ''screenshot_YYYYMMDD_HHMMSS.png'' (and if several are taken during the same second, the ones after the first will be named ''screenshot_YYYYMMDD_HHMMSS_X.png'', where X is the number of the screenshot). If it is set to OFF, screenshots will be named ''screenshot_X.png'', where X is the number of the screenshot. |
+| Automatic screenshots | OFF | If set to ON, screenshots will automatically be taken every X seconds, where X is the screenshot interval set. |
+| Screenshot interval | 30 | If Automatic screenshots is set to ON, screenshots will be taken every X seconds, where X is the screenshot interval set. The value can be set between 1 and 999999, though avoid setting it too low, especially on lower-end platforms, as you could lock yourself. |
+The Font section contains the following options:
+^ Entry ^ Default ^ Function ^
+| <Built-in Font> | [x] | The built-in font of the Player will be used. It is not possible to adjust the size of the built-in font. |
+| CustomFont |   | Font files with the .fon, .fnt, .bdf, .ttf, .ttc, .otf, .woff2, or .woff extension added to the Font directory by the user. When hovered, a preview of the font will be displayed, and the size will be able to be adjusted between 6 and 16. |
+| <Open Font directory> |   | Open the Font directory on desktop platforms. Font files with the .fon, .fnt, .bdf, .ttf, .ttc, .otf, .woff2, or .woff extension must be placed there. For platforms not supporting this, refer to the [[platforms|Platform Differences]] page to know where the Font folder is located.  |
+| <Upload Font> |   | Upload a font file to the Player. This feature is only available on the webplayer, and the font is only stored locally in the user storage, it is not sent to any server.  |