Skip to content
Ludens Ludens Ludens 0.3.0

Settings Reference

Ludens includes a built-in settings screen accessible from the quick actions menu during gameplay. This page documents every available setting, its behavior, and its default values.

The settings system is organized into four sections:

CategorySettingsDescription
SystemTheme, LanguageGlobal preferences for the application’s appearance and language.
ToolsMute Audio, Show FPS, Use WebGL, PositionsUtilities for the game WebView and rendering.
ControlsEnabled, Opacity, Input KeyConfiguration for the on-screen virtual joystick and buttons.
ActionsEnabled, ItemsCustomization of the quick actions menu overlay.

Controls the application’s color scheme.

ValueBehavior
LightForces light theme.
DarkForces dark theme.
SystemFollows the device’s system theme setting.

Controls the application’s UI language (settings screen, labels).

ValueBehavior
SystemFollows the device’s system language.
EnglishForces English UI.
SpanishForces Spanish UI.
PropertyTypeDefault
isMutedBooleanfalse

Mutes all game audio output when enabled. From a technical standpoint, this is handled by injecting JavaScript to toggle the engine’s internal AudioManager (or equivalent in MV/MZ) rather than muting the WebView itself.

This approach ensures that background music and sound effects pause their execution logic, preventing desynchronization issues and saving CPU cycles, which is especially beneficial on mobile devices.

PropertyTypeDefault
showFPSBooleanfalse

Displays a frames-per-second counter overlay when enabled.

PropertyTypeDefault
useWebGLBooleantrue

Controls whether the WebView uses WebGL for hardware-accelerated rendering.

  • When enabled (WebGL): The game leverages the device’s GPU, resulting in significantly better performance, smoother frame rates, and support for advanced visual shaders (like PIXI.js filters).
  • When disabled (Canvas 2D): The game falls back to CPU-based Canvas rendering. This is generally slower but can be useful as a compatibility fallback for older Android devices that struggle with WebGL drivers or experience visual artifacts.

This setting is only available for RPG Maker MV. RPG Maker MZ dropped Canvas 2D support entirely and strictly requires WebGL to function.

Each positionable element (joystick and individual buttons) stores its position as screen coordinates. These can be adjusted through the dedicated positions screen in settings.

For more details on how the position system works, see the Positionable Elements reference.

PropertyTypeDefault
enabledBooleantrue

Master toggle for all on-screen controls (joystick and buttons).

PropertyTypeDefault
alphaFloat

Controls the transparency of on-screen elements to prevent them from blocking the player’s view of the game. The allowed range depends on the type of element, designed specifically to prevent users from accidentally making controls permanently invisible:

  • Joystick and Buttons (A, B, X, Y): 0.15 (minimum) to 1.0 (fully opaque). A minimum of 0.15 ensures the buttons remain faintly visible so the player can still locate them by sight.
  • Quick Actions Menu: 0.35 (minimum) to 1.0 (fully opaque). The quick actions button has a higher minimum opacity because it is the only gateway to access the Settings screen. If it were fully transparent, users could be permanently locked out of their configuration.
PropertyTypeDefault
codeInt

The key code mapped to the button. This property only applies to the on-screen action buttons (A, B, X, Y).

PropertyTypeDefault
enabledBooleantrue

Master toggle for the quick actions menu.

The following quick actions are available:

ActionDescriptionCan be Disabled
SettingsOpens the full settings screen.No
ToggleControlsToggles on-screen controls visibility.Yes
ToggleMuteToggles audio mute.Yes
ToggleFPSToggles FPS counter display.Yes
ToggleWebGLToggles WebGL rendering.Yes

The order and visibility of actions in the quick actions menu can be customized through the settings screen. The Settings action cannot be disabled — it is always available to ensure the user can access the full settings screen.

All settings are persisted using DataStore (protocol buffers). Changes take effect immediately except where a restart is noted. Settings persist across app restarts and updates.