DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Platform Differences =====

EasyRPG Player is available on several platforms, each with their own particularities. This page lists the differences between those different platforms.

 FIXME Add proper documentation for Mac OS, Linux, Wii U, Nintendo Switch, PlayStation Vita, and add more info.

==== General ====

Each platform has its own path for games, RTPs, WildMidi, soundfonts, fonts, configuration and logs. Only the Windows and Linux versions can automatically load a RTP that was installed through the official installer, all other versions require to manually add the RTP in the appropriate directory. The following directories correspond to the following:
  * **Game folder** corresponds to the location where games must be placed.
  * **RTP (2000)** corresponds to the location where the RTP of RPG Maker 2000 must be placed. In said directory, you must directly have the folders of the RTP (Backdrop, Battle, CharSet, ChipSet, FaceSet,...).
  * **RTP (2003)** corresponds to the location where the RTP of RPG Maker 2003 must be placed. In said directory, you must directly have the folders of the RTP (Backdrop, Battle, Battle2, BattleCharSet, BattleWeapon,...).
  * **WildMidi** corresponds to the location where the wildmidi.cfg file must be placed, alongside its instruments folder.
  * **Soundfont folder** corresponds to the location where soundfont files must be placed, all with the .sf2 extension using said format.
  * **Font folder** corresponds to the location where font files must be placed, all with the .fon, .fnt, .bdf, .ttf, .ttc, .otf, .woff2 or .woff extension, and using one of these formats.
  * **Configuration** corresponds to the location where EasyRPG Player will store the settings configuration, after saving the settings through the EasyRPG settings menu.
  * **Log** corresponds to the location where EasyRPG Player will write its logs, if the option Logging is set to ON in the Engine section of the EasyRPG settings menu. Depending on the platform, the logging feature may be ON or OFF by default.

Not all platforms have access to a keyboard and a mouse. On platforms lacking access to these input methods, commands requesting specific actions from these input methods such as Key Input Processing: Mouse, Get Mouse Coordinates or Key Input Processing EX will be reported as not supported by the platform and will not be able to be used properly.

The following settings are exclusive to the following platforms:
  * Fullscreen: Windows & Android
  * Window Zoom: Windows
  * V-Sync & Frame Limiter: Windows, Android, Wii
  * Scaling Method: Windows, Android, Web, Wii
  * Pause when focus lost: Windows, Android, Wii
  * Resolution: Windows, Android, Web, Wii, libretro
  * Scaling: Windows, Android, Web, Wii
  * Native MIDI: Windows
  * Toggle Backlight: 3DS

Additionally, WildMidi is not an option on the webplayer.

Using command line arguments can only be done on desktop platforms and on the webplayer.

==== Performance hits ====

Some platforms are less robust than others, and may struggle more to play games, so if you are trying to play games under proper conditions or know what can be done to help a bit performances, take that in mind.

Loading a game from an archive (zip, lzh, easyrpg) requires to load the archive in memory, which can cause performance issues or crashes on lower-end platforms. Favoritise playing games from a folder on such platforms when possible.
Setting a custom font or soundfont also needs to be put in memory, so those files should ideally either be kept small or be avoided altogether on such platforms. Using a small soundfont with FluidLite should take less memory than relying on FmMidi or WildMidi, additionally.

Custom resolution games may also not work, since bigger games on-screen implies more memory needed. Additionally, some platforms like the 3DS do not support custom resolutions.

Having the logging feature ON will take memory, and as such may be wanted to be disabled on lower-end platforms. It is disabled by default on lower-end platforms, and can be disabled through the EasyRPG settings menu.

The resolution scaling method Bilinear has to allocate an additional texture for the scaling, and as such takes slightly more memory than Integer or Nearest. It can be adjusted through the EasyRPG settings menu.

The following points are usually factors of bad performances:
  * Pictures
  * Sound files
  * Music files
  * Footstep sounds
  * Transition: Mosaic
  * Tints
  * Flashes
  * Big maps
  * Maps with a lot of events happening

Not much can be done about those points, but if you do not mind losing the audio, you can delete files from the Sound and Music folders, this should improve performances without affecting gameplay in most cases.

==== Platforms ====

=== Windows ===

As the Windows version is on the same platform than the original RPG_RT engines, it allows it to use the same native MIDI mode which should give an identical sound.
The location of the RTP is also read in the same way than the original engine, which depends on the entry set in the registry when the RTP is installed through the original installer.

The Windows version looks for files in the following directories:

  * Game folder: Folder of the Player executable
  * WildMidi: Folder of the Player executable
  * Soundfont folder: ''/%USERPROFILE%/AppData/Roaming/EasyRPG/Player/Soundfont/''
  * Font folder: ''/%USERPROFILE%/AppData/Roaming/EasyRPG/Player/Font/''
  * Configuration: ''/%USERPROFILE%/AppData/Roaming/EasyRPG/Player/config.ini''
  * Log: ''/%USERPROFILE%/AppData/Local/EasyRPG-Player.log''

=== Mac OS ===

=== Linux ===

=== Android ===

The Android version uses a completely different layout, to be more adapted to a phone experience. On-screen buttons are displayed on the screen, which can be added, moved, removed, or have their size change.

While in a game, a bug report button is present, which will allow a user to select a mail app, and will automatically set the receiver of the mail to the EasyRPG mail, with the log file and save files attached to properly be able to debug. This feature does not send a mail on its own and only set one, so it can be edited to change the target if you want to send your save files through mail to yourself, for instance.

Due to the need to use a specific Android API to parse game directories, loading game directories can prove to be slow depending on the number of files.

Some of the settings of the Player can be accessed both from the Android layout and from the EasyRPG settings menu. The fonts and soundfont in use can only be selected through the Android layout, and as such cannot be select on the fly while playing.

No Native MIDI setting is present on this platform.

The Android version supports mouse and keyboard controls if a mouse or keyboard is connected to the device. It also has controller support under the same conditions. Alternatively, for mouse inputs, it is possible to use the touch screen, with the coordinates of the mouse being the coordinates of the first finger on the screen, a single finger on the screen will be considered as a left mouse click, two fingers on the screen will be considered as a right mouse click, and three fingers on the screen a middle mouse click.

When selecting a game, it is possible to define the region used and boot the game in debug mode.

The Android version asks the user to select a folder from which EasyRPG files will be read, upon which it will look for files in the following directories:

  * Game folder: ''/<selected-Android-folder>/games/''
  * RTP (2000): ''/<selected-Android-folder>/rtp/2000/''
  * RTP (2003): ''/<selected-Android-folder>/rtp/2003/''
  * Soundfont folder: ''/<selected-Android-folder>/soundfonts/''
  * Font folder: ''/<selected-Android-folder>/fonts/''
  * Configuration: ''/storage/emulated/0/Android/data/org.easyrpg.player/files/config.ini''
  * Log: ''/<selected-Android-folder>/saves/easyrpg-player.log''

Additionally, the ''/<selected-Android-folder>/saves/'' folder is used to write the save data of games that are stored in zip, lzh and easyrpg files.
While WildMidi is displayed in the settings, it currently cannot be set and as such cannot be used (see [[https://github.com/EasyRPG/Player/issues/3598|Player issue #3598]]).

=== libretro ===

The libretro version relies on the libretro system for its input and output, and as such will be limited to the libretro mapping for the key mapping, which prevents access to commands checking specific keys from a keyboard as well as the mouse. The libretro commands should be documented here:
https://github.com/libretro/docs/blob/master/docs/library/easyrpg.md

The libretro version looks for files in the following directories:

  * RTP (2000): ''/<libretro-path-set-for-system-and-bios-files>/rtp/2000/''
  * RTP (2003): ''/<libretro-path-set-for-system-and-bios-files>/rtp/2003/''
  * WildMidi: ''/<libretro-path-set-for-system-and-bios-files>/wildmidi.cfg''
  * Soundfont folder: ''/<libretro-path-set-for-system-and-bios-files>/easyrpg-player/Soundfont/''
  * Font folder: ''/<libretro-path-set-for-system-and-bios-files>/easyrpg-player/Font/''
  * Configuration: ''/<libretro-path-set-for-system-and-bios-files>/easyrpg-player/config.ini''

The libretro version does not need a dedicated game folder location: instead, the user has to select the EasyRPG core, and then can load a game by selecting to open a file of its folder (like selecting the ldb file of the game), or by loading a zip, lzh or easyrpg archive to let EasyRPG Player open it and then select a game within it.
libretro distributions often have an option to scan the selected directory for automatically detecting games of an engine and add them to a library, with a name and pictures to represent the game: as those depend on a [[https://github.com/libretro/libretro-database/blob/master/rdb/RPG%20Maker.rdb|database to detect games]] and a [[https://github.com/libretro-thumbnails/RPG_Maker|database to display the pictures]], that the databases in use are old and that neither of them are maintained, this feature does not work on its own to detect games.

The libretro version doesn't write data to a log file itself. Instead, it forwards its info to the libretro log feature, which has its own settings and save location.

=== Web ===

The web version runs in a browser, and can be played on various devices and OS that either have a keyboard and a mouse or a touch screen. You can find more info on this version and setting it here: https://easyrpg.org/player/guide/webplayer/

No WildMidi and no Native MIDI settings are present on this platform.

Due to being a web browser with files loaded over the internet, there may be delay when loading an asset (see previous guide).

Users can manually provide fonts and soundfonts through the settings menu of the EasyRPG Player, which will then be stored locally in a directory of the browser.

When a player saves on the web version, the save files are also stored in a local directory of the browser, and can manually be downloaded by pressing Shift in the save menu.

=== Wii ===

The Wii version supports 4 different controller methods, Wiimote, Wiimote + Nunchuk, Wiimote + Classic Controller, GameCube Controller. Commands from all players are recognised.

It is also possible to connect a USB Keyboard to the console, which will be recognised and will be able to be used, though it requires manually mapping the keys (see [[https://github.com/EasyRPG/Player/issues/3601|Player issue #3601]]).

FluidSynth is not present on this platform, and is instead replaced by FluidLite. No Native MIDI setting is present on this platform.

The Wii version looks for files in the following directories on the used SD card or USB drive:

  * Game folder: ''/apps/easyrpg-player/''
  * RTP (2000): ''/data/rtp/2000/''
  * RTP (2003): ''/data/rtp/2003/''
  * WildMidi: ''/data/wildmidi.cfg''
  * Soundfont folder: ''/data/easyrpg-player/Soundfont/''
  * Font folder: ''/data/easyrpg-player/Font/''
  * Configuration: ''/data/easyrpg-player/config.ini''
  * Log: ''/data/easyrpg-player/EasyRPG-Player.log''

=== Wii U ===

The Wii U version looks for files on the SD card in the following directories:

  * RTP (2000): ''/wiiu/data/easyrpg-player/rtp/2000/''
  * RTP (2003): ''/wiiu/data/easyrpg-player/rtp/2003/''
  * WildMidi: ''/wiiu/data/easyrpg-player/wildmidi.cfg''
  * Soundfont folder:
  * Font folder:
  * Configuration:
  * Log:

Games are loaded from the same location as the .wubh file of the Player.

=== 3DS ===

The 3DS family of consoles is one of the supported platforms with the less memory available, and as such games are more prone to lag and crashes there.

FluidSynth is not present on this platform, and is instead replaced by FluidLite. No Native MIDI setting is present on this platform.

When playing, a virtual numpad is present on the bottom screen, which can be hidden by touching the screen in the upper-right corner. The visibility of the numpad can also be adjusted in the settings menu and can be saved by selecting save settings.

On non-New models (3DS, 3DS XL, 2DS), the speed of music and sound effects will be kept at 100% and ignore speed parameters to avoid more performance issues.

The exclusive buttons of the New models (ZL, ZR, C-stick) are not recognised by the Player, nor are the buttons from the Circle Pad Pro accessory.

The 3DS version looks for files on the (Micro) SD Card in the following directories:

  * Game folder: ''/3ds/easyrpg-player/''
  * RTP (2000): ''/data/rtp/2000/''
  * RTP (2003): ''/data/rtp/2003/''
  * Soundfont folder: ''/data/easyrpg-player/Soundfont/''
  * Font folder: ''/data/easyrpg-player/Font/''
  * Configuration: ''/data/easyrpg-player/config.ini''
  * Log: ''/data/easyrpg-player/EasyRPG-Player.log''

If you use the .cia version, WildMidi is bundled inside the EasyRPG Player and reads its configuration from it, so an external WildMidi configuration cannot be provided.
If you use the .3dsx version, then the wildmidi.cfg file will be read from directory of the .3dsx file.

=== Nintendo Switch ===

The Nintendo Switch file system interprets reads from the MicroSD card as using Shift-JIS, even if it is not the case. As such, if you want to play a game that contains characters for its filenames not present in the Japanese character set, you will need to put your game in a zip, lzh or easyrpg archive to be able to boot it.

The Nintendo Switch version looks for files on the MicroSD Card in the following directories:

  * RTP (2000): ''/switch/easyrpg-player/rtp/2000/''
  * RTP (2003): ''/switch/easyrpg-player/rtp/2003/''
  * WildMidi:
  * Soundfont folder:
  * Font folder:
  * Configuration:
  * Log:

Games are loaded from the same location as the .nro file of the Player.

=== PlayStation Vita ===

The PlayStation Vita version looks for files on the memory card in the following directories:

  * Game folder: ''/data/easyrpg-player/''
  * RTP (2000): ''/data/easyrpg-player/rtp/2000/''
  * RTP (2003): ''/data/easyrpg-player/rtp/2003/''
  * WildMidi: ''/data/easyrpg-player/wildmidi.cfg''
  * Soundfont folder:
  * Font folder:
  * Configuration:
  * Log: