How to Use BoxLib's Prompt System for In-Game Text Input

BoxLib includes a prompt system that lets mods ask you for text input without leaving the current screen. If you have seen a small popup asking you to type a name, a search term, or a command argument, that was likely a BoxLib prompt.

What a Prompt Looks Like

A prompt is a lightweight overlay: a text field, a confirm action, and a cancel action. It does not replace the whole screen, so you keep your context while typing. Mods trigger prompts for things like renaming a saved entry, entering a filter string, or supplying a value that a command needs.

Responding to a Prompt

1. When a prompt appears, the text field is focused automatically. Start typing your input.

2. Press Enter to confirm, or click the confirm button. The mod receives your text and continues its logic.

3. Press Escape or click cancel to dismiss the prompt. The mod treats this as an aborted action.

When Prompts Appear

Prompts are triggered by the mod using BoxLib, not by BoxLib itself. If a prompt shows up unexpectedly, it is because the mod you are interacting with decided it needed input at that moment. Cancelling is always safe; it simply returns control without applying anything.

Tips

• Prompts pause your input to the world while open, so you will not accidentally move or attack.
• Long input is supported; the field scrolls as you type.