MC-WIKI.net
IMBlocker Wiki › Guides › Managing Recorded Screens, Whitelist Entries, and Char Simulation Screens in IMBlocker

Managing Recorded Screens, Whitelist Entries, and Char Simulation Screens in IMBlocker

guide

IMBlocker gives you several lists and switches for deciding where your input method editor should activate, how it should behave when a text field gains focus, and how the mod locates the focused element on certain screens. This guide covers the recorded screen list, whitelist editing, and the char simulation-preferred screens, along with the settings that shape English-state behavior.

Recorded Screens and Whitelist Editing

The enableScreenRecovering option turns Screen Recovering on. When it is active, the mod keeps a record of the screens it has encountered.

The recorded screens appear in a list described as containing all recorded Screens for whitelist editing. This list is where you manage which screens are treated as text-input screens: any screen you place on the whitelist will cause your IME to turn on when that screen is open. Use the list to add, review, or remove entries so that only the screens you want are covered.

Char Simulation-Preferred Screens

The charSimulationScreens list holds screens that should locate the focus owner through char simulation. For every screen you add here, the mod determines which element holds focus by simulating a character, an approach the mod describes as having full accuracy.

The probe character is normally absorbed safely by the injection, but the mod notes that compatibility problems can arise in some situations. Keep this in mind when adding screens, and remove an entry if it causes trouble.

English State Settings

englishStateImpl controls which method is used to apply the English state. The available guidance is:

  • CONVERSION_STATUS is generally the recommended choice only for users of Microsoft IME.
  • RIME is the main option for Weasel, Squirrel, and fcitx5-rime.
  • DISABLE_IM is for cases where your IME cannot switch to English state on its own. With this choice, you unlock the IME yourself using the hotkey (R-Shift by default).

primaryEnglishState sets the English state your IME starts in when a text field receives focus. This is aimed mainly at Chinese users who are accustomed to searching with JECh. The setting does not apply to the chat field or to mods that involve few search situations.

enableConversionStatusApi allows the ConversionStatus API, which is the interface that governs the English state. If you turn it off, the CONVERSION_STATUS implementation of English state stops working.

Compatibility Settings

Under modCompatibilitySettings, the sfm$showLineNumber option controls SFM: Show Line Number.

Under windowsCompatibilitySettings:

  • enableCursorPositionTracking toggles Caret Position Tracking.
  • enableCompositionFontTweaks toggles Composition Font Tweaks. Its guidance covers rendering candidates manually when exclusive fullscreen is enabled, and it is recommended only when the IME candidate window cannot be seen in exclusive fullscreen. The IME's own candidate window offers more features.

Under linuxCompatibilitySettings:

  • enableKeyboardPatch applies a callback-level keyboard patch that stops non-character keys from reaching the game while candidates are displayed. If the candidate window closes because pre-edit characters were erased with Backspace, the game may stop handling non-character keys; pressing Esc or typing any character resolves this.
  • ibusOnArgName and ibusOffArgName are the arguments for the IBus enable and disable commands. To find the right value, run `ibus engine <argument>` in a terminal and check whether the IME turns on or off.
  • fcitx5OnArgName and fcitx5OffArgName are the arguments for the Fcitx5 enable and disable commands. Determine them by running `fcitx5-remote <argument>` in a terminal.
  • fcitx5OnStateName is the identifier Fcitx5 returns when enabled. Run `fcitx5-remote` in a terminal to see the returned value.

Command Prefix Regex

commandPrefixRegex is available for defining the command prefix pattern.

Practical Order of Operations

Start by enabling enableScreenRecovering so screens are recorded, then open the recorded screen list and edit the whitelist to match the screens where you want your IME active. Add screens to charSimulationScreens only when you want focus located by char simulation. Finish by choosing your englishStateImpl method and, if needed, your primaryEnglishState, then adjust the compatibility options for your platform.